Create Docupass Link

post

https://endpoint.example.com/docupass

Create a new Docupass link for rapid identity verification and/or e-signature

Body Params

profile

string

Custom KYC Profile ID

mode

string

0=Document+Face 1=Document Only 2=Face Only 3=e-Signature Only

verifyAddress

string

verifyDocumentNumber

string

verifyAge

string

verifyName

string

verifyDOB

string

verifyPostcode

string

userPhone

string

Supply user phone number for verification, must enable phoneVerification in profile settings.

customData

string

language

string

Override auto language detection

reusable

boolean

Whether the generated link can be used to verify multiple person

referenceDocument

string

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

referenceDocumentBack

string

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

referenceFace

string

Base64 encoded face image, if supplied, no face image will be captured. Required if mode=2.

contractGenerate

string

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

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.

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".

Response

200OK