Create a hosted Docupass flow

post

https://api2.idanalyzer.com/docupass

Create a Docupass URL and QR code for a hosted identity verification or e-signature journey.

Docupass is the quickest way to launch mobile-friendly onboarding without building your own document capture UI. You can share the link directly, embed it in an iframe, open it in a lightbox, or load it inside a mobile webview.

Body Params

version

string

Version	Description
`3`	Latest Docupass version with improved UI, security and more languages supports.
`2`	Deprecated Docupass version.

If no version parameter is not provided, a version 2 Docupass link will be generated for compatability. On August 1st 2024, the default version will be switched to the newest version 3.

profile

string

Custom KYC Profile ID, make sure to edit the Docupass section under the profile, you may also add a webhook to receive information when user completes Docupass.

mode

integer

Docupass flow mode. Common values are 0 for document plus selfie verification, 1 for document only, 2 for selfie/reference verification, and 3 for verification plus e-signature.

customData

string

Any arbitrary customer data you want to include with this Docupass transaction, for example, database id of your user.

contractSign

string

Generate a document using information from uploaded ID, and have the user review and sign the document after identity verification. Required for mode=3.

userPhone

string

Supply user phone number for verification, must enable phoneVerification in profile settings. If no number is provided, users will be asked to enter their phone number for verification.

verifyAddress

string

User must present ID matching the address provided

verifyDocumentNumber

string

User must present ID matching the document number provided

verifyAge

string

User must be between the specified age to pass verification.

verifyName

string

User must present ID matching the name provided

verifyDOB

string

User must present ID matching the date of birth provided. For example, "20-40", a warning will be trigger if age is under 20 or over 40.

verifyPostcode

string

User must present ID matching the postcode provided

language

string

Docupass will auto detect and display language based on end-user system, to override this you can provide a language code.

Code	Language
en	English
tw	繁體中文
cn	简体中文
fr	Français
nl	Nederlands
de	Deutsch
es	Español
ja	日本語
ko	한국어
tl	Tagalog
th	ภาษาไทย
id	Bahasa Indonesia
vi	Tiếng Việt
hi	हिन्दी
pt	Português
ar	العربية
bn	বাংলা
ur	اردو

contractGenerate

string

Generate up to 5 documents using information from uploaded ID, without user reviewing or signing the document.

contractFormat

string

PDF DOCX HTML

contractPrefill

object

JSON data in key-value pairs to autofill dynamic fields, data from user ID will be used first in case of a conflict. For example, passing {"myparameter":"abc"} would fill %{myparameter} in contract template with "abc".

referenceDocumentBack

string

Base64 encoded document back image, if supplied, no document back image will be captured.

referenceDocument

string

Base64 encoded document image, if supplied, no document front image will be captured.

referenceFace

string

Base64 encoded face image, if supplied, no face image will be captured. Required for face verification only mode without uploading documents.

profileOverride

object

Override one or more parameters on the existing profile, the object should be JSON style object adhering to Get KYC Profile API response.

Response

200OK