/access/useVerificationCode

Uses a verification code to set a time field to the current time. Any particular verification code can only be used once. This is often used for items like email verification.

This endpoint supports the following methods:

  • GET

GET

Authentication

No authentication is required to call this endpoint.

Base URL

The base URL for this endpoint is your 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


curl -G --data-urlencode verification_code=12345678912345678912345678912345 \
   https://my-app.janraincapture.com/access/useVerificationCode
                                                   
      Running this command in Postman

Authorized Clients

  • no-auth-required

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