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
  • DCAMS+ & DCAMS+REVIEW Matching Rules
  1. dcams
  2. Document Capture and Management Services
  3. iFrame

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://dcams.app/v3/stable/token/create

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

Request Body

Name
Type
Required
Description

user

string

true

Your Veratad API username

pass

string

true

Your Veratad API Password

age

string

true

The age you want to check.This needs to be sent with a "+" at the end like "21+". In that example you are checking that the user is 21 and above.

rules

string

false

The DCAMS+ and DCAMS+Review data matching rules. See below for values.

company_name_for_email

string

false

Use this to change the company name that appears in the email sent to the customer.

email_logo_link

string

false

Set a link to a logo image to be placed on the top of the email to the customer

email_logo_height

string

false

Set the logo height in px

email_logo_width

string

false

Set the logo width in px

store_on

string

false

If DCAMS Storage is active in your account you can decide what DCAMS+ Scan result you want to store. Acceptable values are: PASS FAIL ALL If you do not specify this value the document will not be stored.

redirect_uri

string

false

The URL that you would like a user returned to in a redirect or handoff flow.

{
    "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",
    "redirect_uri": "https://example.com/return?req=123"
}
{
    "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",
    "pass": "PASSWORD",
    "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",
    "redirect_uri": "https://example.com/return?req=123"
}

DCAMS+ & DCAMS+REVIEW Matching Rules

When processing a scan or a manual review you can define what elements from your customer parameters must match the information found on the document provided.

EXAMPLE

If you send DCAMS5_0_RuleSet_NAME_DOB this means that the Name and Date of Birth from your customer's parameters must match the Name and Date of Birth found on the document.

If you leave this value empty then NO matching rules will be used.

Here are the available DCAMS+ rule sets:

  • DCAMS5_0_RuleSet_NAME_DOB

  • DCAMS5_0_RuleSet_NAME

  • DCAMS5_0_RuleSet_NAME_ADDR

  • DCAMS5_0_RuleSet_NAME_STATE

  • DCAMS5_0_RuleSet_NAME_STATE_DOB

  • DCAMS5_0_RuleSet_NAME_ADDR_DOB

Here are the available DCAMS+REVIEW rule sets:

  • DCAMS5_0_Manual_Review_RuleSet_NAME_DOB

  • DCAMS5_0_Manual_Review_RuleSet_NAME

PreviousCanned ResponsesNextView Callback

Last updated 9 months ago