/access/getVerificationCode

Gets a verification code that can later be used with useVerificationCode. The useVerificationCode call sets a time field in an entity to the current time. This is useful for recording timestamps for when an email address was verified, or similar purposes.

This endpoint supports the following methods:

  • GET

GET

Base URL

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

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

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

Examples

Example Request

The example shows a request that gets a verification code for setting an attribute named "emailVerified" in the Person entity with an id of 1.


curl -H "Authorization: Basic aW1fYV...NfbXk=" \
    --data-urlencode id=1\
    --data-urlencode type_name=Person \
    --data-urlencode attribute_name=emailVerified \
    https://my-app.janraincapture.com/access/getVerificationCode
                                                

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Authorized Clients

owner direct_access

Security

  •  janrain-signed
  •  basic-auth
  •  janrain-oauth

Query Parameters

Parameter Type Required Description
uuid string UUID of the user account. This parameter is required unless you are using either the id parameter or the key_attribute parameter.
 
id string ID of the user account. This parameter is required unless you are using either the uuid parameter or the key_attribute parameter.
 
key_attribute string Unique attribute found in the user account schema. This parameter is required unless you are using either the id parameter or the uuid parameter.
 
key_value string Value assigned to the key_attribute parameter.
 
type_name string Yes Name of the entityType where the user account is stored.
 
attribute_name string Yes Name of the attribute to be updated when using the verification code.
 
lifetime string Number of seconds the verification code is valid for. The default lifetime is seven days (604800 seconds).
 

Responses

200 OK

Response Example (application/json)


{
  "verification_code": "htjwg2uphwz5mqxrnqe4tuvpxkzaqrr5",
  "stat": "ok"
}