Use a Verification Code

Endpoint URL: {registrationDomain} /access/useVerificationCode

Description

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

Authentication

No authentication is required to call this endpoint.

Base URL

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

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

Your Capture domains (also known as Registration domains) can be found in the 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

Running this command in Postman

Query Parameters

Parameter	Type	Required	Description
verification_code	string	Yes	Verification code obtained in a prior call to the access/getVerificationCode endpoint.

Responses

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"
}

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

        abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

        echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

        [Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.