Create Session
Overview
The VX API provides a comprehensive solution for creating and managing verification sessions. This guide covers:
Authentication - Obtain a bearer token for authorization.
Create Session - Generate a verification session link.
Get Session Status - Obtain the results through a webhook or polling.
iFrame Integration (optional) - Embed the verification link and handle post message events.
Authentication
To interact with the VX API, you must first obtain a Bearer token. This token will authenticate your application for all subsequent requests.
Endpoint
POST https://auth.dcams.app/oauth/token
Request Body
Request Details
client_id: Provided by your administrator, this identifies your application.
client_secret: A secret key provided by your administrator for authenticating your application.
audience: Specifies the target API, which should be
"dcams.app"
.grant_type: Always set to
"client_credentials"
for this type of request.
Responses
Create Session
After obtaining the Bearer token, you can create a verification session. This session will return a link that the user can use to complete the verification process.
Endpoint
POST https://vx.dcams.app/api/session/create_session
Headers
Authorization:
Bearer {{access_token}}
(where{{access_token}}
is the token obtained from the Authentication step)
Required Fields
email: The user's email address. This field is used as the primary identifier of a user, but the email address does not need to be real or working as we will never send the user an email.
age: The user's age, which must be in the format
"21+"
(with the plus sign to indicate "age to check and over"). NOTE: "21" is just the example, please use any value that fits your use case.
Optional Fields
route_id: The route ID to use for this session. If not provided, the default route associated with the
client_id
will be used.settings_id: Specifies the settings for the session. If not provided, default settings associated with the
client_id
will be used.brand_id: Specifies the brand for the session. If not provided, a default brand associated with the
client_id
will be used.There are several more optional fields in the full example below.
Request (Simple Example)
Request Body (Complete Example with All Optional Fields)
Responses
You are limited to 1,000 requests per minute to the create session endpoint. If you require a larger throughput please contact our support team.
Last updated