Use a Verification Code

Endpoint URL: {registrationDomain} /access/useVerificationCode


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.

Respects the API Client Allow List: No


No authentication is required to call this endpoint.

Base URL

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

Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:


Example Request

This command submits the verification code kgb7kj2sqj7t6x77gv62fjpae3gw6jzv.

curl -X POST \
  --data-urlencode verification_code=kgb7kj2sqj7t6x77gv62fjpae3gw6jzv \

      Running this command in Postman

Query Parameters

verification_codestringYesVerification code obtained in a prior call to the access/getVerificationCode endpoint.


200 OK

Example Error Response

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

Response Example (application/json)

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