# Web SDK ## What are the steps for getting set up? ### 1. Create Token In order for the document scan/upload process to work you must submit a token within the parameters of the `veratadModal`. ```javascript veratadModal = new veratad.modal({ token: "8dfe0180-5389-46d4-a28c-b74061d8e7c3", }); ``` To get a token you must make an API call with your Veratad username and password. See link below for more details. {% content-ref url="createtoken" %} [createtoken](https://api.veratad.com/vx/overview/createtoken) {% endcontent-ref %} {% hint style="warning" %} Tokens are only valid for 6 hours. It is recommended that you get a new token on each iFrame build. {% endhint %} ### 2. Include CSS, JS and iFrame {% tabs %} {% tab title="CSS" %} ```markup ``` {% endtab %} {% tab title="JS" %} ``` ``` {% endtab %} {% tab title="iFrame" %} ``` ``` {% endtab %} {% endtabs %} ## Full Example {% hint style="info" %} This example includes all parameters, functions and methods. {% endhint %} ```markup ``` ## Functions | Name | Description | | ------------------------ | --------------------------------------------------------------------------------------------- | | onOpen() | Triggers when the modal is first opened on the page or with the `open()` method | | onClose() | Triggers when the modal is closed by the user or with the `close()` method | | onSuccess() | The document was successfully scanned or successfully uploaded if DCAMS+ is not active | | onFailure() | The document failed the scan process or was not uploaded successfully if DCAMS+ is not active | | onEmail() | The user has requested that they get an email with a link to scan. | | onQr() | The user pushed the "done" button after QR scanning. | | onError() | A general processing error occurred during the scan or upload process. | | onErrorToken() | An invalid token was supplied | | onErrorPending() | The user's document is currently in a `PENDING` state and they cannot submit a new document | | onErrorAlreadyVerified() | The user is in a `PASS` state already | | onErrorVelocity() | The user has already processed 3 attempts within a 24 hour period | ## Methods | Name | Description | | --------- | ----------------------------------------------------------------- | | open() | Open the modal. i.e. `veratadModal.open();` | | close() | Close the modal i.e. `veratadModal.close();` | | destroy() | Destroy the modal and all variables i.e. `veratadModal.destroy()` | ## Parameters | Parameter | Required | Type | Description | | ------------------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | international | optional | boolean | If the upload should be treated as a non-US document. Default is `false` | | fn | required | string | The customer's first name | | ln | required | string | The customer's last name | | addr | required | string | The customer's street address | | city | required | string | The customer's city | | state | required | string | The customer's state | | zip | required | string | The customer's zip code | | dob | required | string |

The customer's Date of Birth

(YYYYMMDD format)

| | phone | optional | string |

The customer's phone number formatted as any of the below:

(555) 555-5555
555-555-5555
5555555555

| | | | | | | email | required | string | The customer's email address | | reference | optional | string | An arbitrary value that will be returned with the callback | | token | required | string | The token for the iFrame session | | styleToken | optional | string | You can create a style ID in the admin dashboard. Once created enter the value in this parameter to customize the iFrame style. | | qr | optional | boolean | If set to "true" then the user will be given a prompt to scan a QR code when they select the "Use My Phone" option when on desktop. | | additionalData | optional | object | Any additional data you would like sent back with the callback POST. This can be set with any key => value pairs. | | resultMessages | optional | object | See `resultMessages` section below for more explanation. | | language | optional | string |

If no language is specified then the system will default to English. All languages from the Google Translate API are supported. Click here to view.

The value should be the ISO-639-1 Code.

| | email\_fallback | optional | boolean | The system will default to "true". If this is set to 'false" the user will never be given the option to send an email if they are having trouble with the QR. In order for this to work the "QR" attribute also needs to be set to "true". | | bypassDesktopIntro | optional | boolean | The system will default to "false". If you set this attribute to "true" then the user will go direct to either the QR or Email link flow depending on your QR settings. | ### resultMessages These are the messages displayed to the end user in the iFrame. {% hint style="info" %} **NOTE:** If you do not want the user to be messaged in the iFrame you can simply run the `veratadModal.close()` after one of the function callbacks. That said, If you do not customize these messages then your users that get an email link sent to them will see the defaults on the page. {% endhint %} {% tabs %} {% tab title="Success" %} **The user has passed verification or successfully uploaded if DCAMS+ is not active, but storage is active.** | parameter | default message | | --------------------------- | ---------------------------- | | verificationSuccessTitle | Verification Success | | verificationSuccessSubTitle | You have passed verification | | {% endtab %} | | {% tab title="Failure" %} **The user did not PASS DCAMS+ verification or the image was not uploaded.** | parameter | default message | | --------------------------- | -------------------------------------- | | verificationFailureTitle | Verification Failed | | verificationFailureSubTitle | Your document is pending manual review | | {% endtab %} | | {% tab title="Error" %} **Something went wrong and no verification was processed. There are 4 error states:** 1. **Token** - the token provided in the iFrame is not valid 2. **Already Verified** - the user (based on email) has already `PASSED` verification 3. **Pending** - the user (based on email) is currently in a `PENDING` state of verification 4. **Velocity** - The user has exceeded the `velocity_threshold` | parameter | default message | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | verificationErrorTokenTitle | Bad or Expired Token | | verificationErrorTokenSubTitle | This document scan instance is using a bad or expired token. Please contact customer service. | | verificationErrorAlreadyVerifiedTitle | You Are Already Verified | | verificationErrorAlreadyVerifiedSubTitle | You have already passed this process and are not able to upload a new document at this time. Please call Customer Service. | | verificationErrorPendingTitle | Your Document is Currently Pending Manual Review | | verificationErrorPendingSubTitle | Your document is currently pending manual review and you may not provide another document at this time. Please call Customer Service. | | verificationErrorVelocityTitle | Too Many Attempts | | verificationErrorVelocitySubTitle | You have exceeded the amount of verification attempts. Please call Customer Service. | | {% endtab %} | | | {% endtabs %} | | ## Callback Once a document is uploaded, the callback will fire. The callback will also fire on subsequent status updates. The `email` or `reference` values can be used to associate the upload on Veratad's side to a customer/order on your side. {% hint style="danger" %} You should always use the backend callback POST to get the official status of the customer/order. The frontend callback in the JS should only be used to message and route your customer on the frontend. {% endhint %} #### Set up your callback endpoint Click the link to create your callback endpoint {% content-ref url="broken-reference" %} [Broken link](https://api.veratad.com/vx/overview/broken-reference) {% endcontent-ref %} ### Example ```javascript POST {The URL you setup} ``` #### Body ```javascript { "fn": "John", "ln": "Smith", "addr": "123 Main St", "city": "Stratford", "state": "CT", "zip": "06614", "dob": "19880521", "email": "test@veratad.com", "reference": "12345-test", "status": "PENDING", "additionalData": { "value_1": "test1", "value_2": "test2" }, "dcams_plus": { "document_data": { "FirstName": "LOUISA", "LastName": "SAMPLE", "MiddleName": "ANNA", "FullAddress": "109 S FOSTER RD, BATON ROUGE, LA, 70808-0000", "Address": "109 S FOSTER RD", "City": "BATON ROUGE", "State": "LA", "Zip": "70808-0000", "DateOfBirth": "19720629", "Height": "5-08", "Sex": "F", "EyeColor": "BRN", "DocumentNumber": "003009381", "IssueDate": "20140714", "ExpirationDate": "20300629", "CountryCode": "USA", // (ISO Alpha 2 or 3) "DocumentType": "DRIVERS LICENSE" // other values are PASSPORT, IDENTITY CARD and UNKNOWN }, "confirmation": 92480850, "action": "REVIEW", "issues": ["DOB DOES NOT MATCH DOCUMENT", "FIRST NAME DOES NOT MATCH DOCUMENT"], "detail": "TRANSACTION REQUIRES FURTHER ATTENTION" }, "storage": { "success": false } } ``` #### Body (When Image Return is Active) There is a setting when a company is not using the Veratad storage system to have the document images returned via the callback. If this setting is active then the callback body will be as follows. ```javascript { "fn": "John", "ln": "Smith", "addr": "123 Main St", "city": "Stratford", "state": "CT", "zip": "06614", "dob": "19880521", "email": "test@veratad.com", "reference": "12345-test", "status": "PENDING", "additionalData": { "value_1": "test1", "value_2": "test2" }, "dcams_plus": { "document_data": { "FirstName": "LOUISA", "LastName": "SAMPLE", "MiddleName": "ANNA", "FullAddress": "109 S FOSTER RD, BATON ROUGE, LA, 70808-0000", "Address": "109 S FOSTER RD", "City": "BATON ROUGE", "State": "LA", "Zip": "70808-0000", "DateOfBirth": "19720629", "Height": "5-08", "Sex": "F", "EyeColor": "BRN", "DocumentNumber": "003009381", "IssueDate": "20140714", "ExpirationDate": "20300629", "CountryCode": "USA", // (ISO Alpha 2 or 3) "DocumentType": "DRIVERS LICENSE" // other values are PASSPORT, IDENTITY CARD and UNKNOWN }, "confirmation": 92480850, "issues": ["DOB DOES NOT MATCH DOCUMENT", "FIRST NAME DOES NOT MATCH DOCUMENT"], "detail": "TRANSACTION REQUIRES FURTHER ATTENTION" }, "storage": { "success": false }, "documents": { "front": "BASE 64 Encoded Image String", "back": "BASE 64 Encoded Image String" } } ``` #### Possible Status Values | status | description | | ------- | ------------------------------------ | | PASS | The document has passed verification | | PENDING | The document is under manual review | | FAIL | The document has failed verification | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api.veratad.com/vx/overview/web-sdk.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.