Standard ID Scan

Initiate a new identity document scan & ID face verification transaction by uploading based64-encoded images.

Body Params
string
required

Base64-encoded Document Image, you may also reference image from another transaction by passing "ref:abcde" where abcde is the output image reference.

string

Base64-encoded Document(Back) Image, you may also reference image from another transaction by passing "ref:abcde" where abcde is the output image reference.

string

Base64-encoded Face Image for Biometric Verification, you may submit multiple images by separating each image with a comma. Multiple images will improve liveness verification accuracy. You may also reference image from another transaction by passing "ref:abcde" where abcde is the output image reference.

string

Base64-encoded selfie video for Biometric Verification.

string
required

Enter your custom KYC profile ID, or use one of the following preset profiles: "security_none", "security_low", "security_medium", "security_high"

profileOverride
object

Override any particular setting on the existing profile

string

Accepted Issuer Country (ISO-Alpha2 Code separated by comma)

string

Accepted Issuer State (ISO-Alpha2 Code separated by comma)

string

Accepted ID Type (I=ID, P=Passport, D=Driving License, V=Visa, R=Residence Permit)

string

Supply customer name to match with document

string

Supply customer birthday to match with document

string

Supply an age range to check if customer is within the age range. For example, "20-40", a warning will be trigger if age is under 20 or over 40.

string

Supply customer address to match with document

string

Supply customer postcode to match with document

string

Supply customer ID number to match with document

string

Enter up to 5 contract template ID (seperated by comma) to automatically generate contract document using value parsed from uploaded ID

string

PDF, DOCX or 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".

string

Pass in user IP address to check if ID is issued from the same country as the IP address, use value "user" to use connection IP.

string

Any arbitrary string you wish to save with the transaction. e.g Internal customer reference number

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/xml