Verify User
POST {{authPath}}/{{envID}}/flows/{{flowID}}
The POST /{{envID}}/flows/{{flowID}}
operation initiates an action to verify the user account to continue the authentication flow. The user must click the link in the verification email to verify the account. The request body requires the verificationCode
attribute identifying the verification code to check. This operation uses the application/vnd.pingidentity.user.verify+json
custom media type as the content type in the request header. The account verification code is 8 alphanumeric characters and has no timeout. These attributes are not configurable.
Prerequisites
See Flows for important overview information.
Send an authorize request to get a flow ID: Authorize. See also PingOne basic login authentication flow and Authentication workflow walkthrough.
Start the flow: Read Flow.
See also the
VERIFICATION_REQUIRED
andVERIFICATION_CODE_REQUIRED
flow states in the Flow status values table.
Property | Type | Required? |
---|---|---|
verificationCode | String | Required |
Request Body
{"verificationCode"=>"xxxxxx"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Cookie | string |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/038ceb72-471c-4679-abb4-a0d59ff5d01b"}},"id":"038ceb72-471c-4679-abb4-a0d59ff5d01b","session":{"id":"20d7fa9f-a2f0-46d4-b058-0d2786bcba59"},"resumeUrl":"https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as/resume?flowId=038ceb72-471c-4679-abb4-a0d59ff5d01b","status":"COMPLETED","createdAt":"2021-04-27T00:03:33.648Z","expiresAt":"2021-04-27T00:19:44.130Z","_embedded":{"user":{"id":"ffc8b7f4-9fdc-4f66-82bb-4e2142ab25ee","username":"registered-user_2"},"application":{"name":"RegistrationUseCaseApp"}}}