Use a verification code

Uses a verification code to set a time field to the current time. This is often used for items like email verification. For example, if the emailVerified attribute has a value that means that the user has verified their email address. If the attribute value is NULL then the user has not verified their email address.

Authentication

No authentication is required to call this operation.

Base URL

The base URL for this operation is your Identity Cloud Capture domain; for example:

https://educationcenter.us- dev.janraincapture.com

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.

Examples

Example Request

This command submits the verification code kgb7kj2sqj7t6x77gv62fjpae3gw6jzv.

curl -X POST \
  --data-urlencode verification_code=kgb7kj2sqj7t6x77gv62fjpae3gw6jzv \
  https://my-app.janraincapture.com/access/useVerificationCode

Parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.

Responses

200 OK

Example error response

Most of the Authentication API operations return the HTTP status code 200 OK regardless of whether the call succeeded or not. If you call didn't succeed, the stat property in the response will be set to error and you'll see additional properties such as code and error_description. See Registration error codes for more information.

{
    "argument_name": "verification_code",
    "request_id": "fvdfxwpxew2qe76p",
    "code": 200,
    "error_description": "verification code not recognized",
    "error": "invalid_argument",
    "stat": "error"
}

Response example (application/json)

If your API call succeeds you'll get back the unique identifier of the user account:

{
  "stat": "ok",
  "uuid": "7d19b6f2-bba2-48ba-9442-19d396427d77"
}