LogoLogo
  • API Documentation
  • Authentication
  • Testing
  • Contact Support
  • System Status
  • VX
    • Create Session
    • API Methods
  • Agematch
    • United States
    • United States (DMV)
    • International
    • With KBA Quiz
    • Selfie Age Estimation
  • IDMATCH
    • United States
      • With KBA Escalation
      • KYC/CIP Compliance
      • COPPA Compliance
    • International
  • idmatch+
    • United States
  • IDMATCH+PREDICT
    • Fraud Score
  • phonematch
    • Verification and Validation
      • Smart 2FA
      • Phone Verification
      • Phone Validation
    • One Time Passwords
      • SMS
      • Call
    • Message Delivery
      • Dialer
  • emailmatch
    • Email Validation
  • dcams
    • Document Capture and Management Services
      • Scanning Basic
      • Scanning Enhanced
      • Manual Review
      • Storage
        • Create or Update a Customer
        • Get Customer Status
        • Get Customer Document Images
        • Update Customer Status
      • iFrame
        • Canned Responses
        • Create Token
        • View Callback
        • User Status
        • Generate Link
      • Swift SDK
      • Android SDK
  • Bouncer
    • Overview
    • Bouncer as an add-on
  • V-PIN
    • Overview
    • V-PIN as an add-on
    • V-PIN Stand Alone
  • Service Coverage
    • Data Coverage
  • Testing
    • Test Cases
    • Answers to KBA Questions
  • Reporting
    • Audit
  • API Processing Errors
    • Error Returns
  • Knowledge Base
    • Best Practices
    • Understanding Veratad Services
  • IDMax
    • IDMax Button Creator SDK
Powered by GitBook
On this page
  • Create Token
  • Request Body
  1. VX
  2. API Methods

Create Token

The Create Token process is designed to generate a unique token to be used in the frontend of the iFrame solution in order to identify your site and settings to Veratad.

Create Token

POST https://vx-be.idresponse.com/token/create

This endpoint creates your token with associated settings to access a document iFrame session.

Request Body

Name
Type
Description

user*

string

Your Veratad API username

pass*

string

Your Veratad API Password

journey_id

String

The VX journey ID to be loaded with this token

settings_id

String

The settings profile ID to be loaded with this token

branding_id

String

The branding ID to be loaded with this token

{
    "result": "Success",
    "message": "Token created successfully",
    "token": "393d50f9-2703-4100-9e4b-dfd8e4fda493",
    "age": "21+",
    "rules": "DCAMS5_0_RuleSet_NAME_DOB",
    "store_on": "FAIL",
    "company_name_for_email": "Company ABC",
    "email_logo_link": "https://yourcompany.com/logo.png",
    "email_logo_height": "50",
    "email_logo_width": "80",
    "dcams_manual_rules": "DCAMS5_0_Manual_Review_RuleSet_NAME_DOB"
}
{
    "result": "Error",
    "message": "Missing a required input",
    "token": ""
}

{
    "result": "Error",
    "message": "Invalid age submitted. Must conform to age+ like 21+",
    "token": ""
}

{
    "result": "Error",
    "message": "Invalid ruleset submitted. Please check the documentation",
    "token": ""
}

{
    "result": "Error",
    "message": "Invalid store_on value. Must be PASS, FAIL or ALL",
    "token": ""
}
{
    "result": "Error",
    "message": "Either your username or password is incorrect",
    "token": ""
}

IMPORTANT: The token is only good for 6 hours. It is recommended that you generate a new token on each iFrame request.

Request Body

{
    "user": "USERNAME | API KEY",
    "pass": "PASSWORD",
    "journey_id": "SET | DEFAULT", 
    "settings_id": "SET | DEFAULT", 
    "branding_id": "SET | DEFAULT"
}

Last updated 8 months ago