Run a full ID verification scan

post

https://api2.idanalyzer.com/scan

Use the Standard ID Verification API for the complete identity verification workflow: document OCR, document classification, validation warnings, fraud checks, optional face match, optional AML screening, document automation, and a final KYC decision.

This is the best endpoint for customer onboarding, age verification, fraud prevention, marketplace trust, travel verification, and regulated KYC / KYB style reviews where you need more than simple OCR extraction.

Body Params

document

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.

documentBack

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.

face

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.

faceVideo

string

Base64-encoded selfie video for Biometric Verification.

profile

string

required

KYC profile ID or a preset profile such as security_none, security_low, security_medium, or security_high.

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.

restrictCountry

string

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

restrictState

string

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

restrictType

string

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

verifyName

string

Supply customer name to match with document

verifyDob

string

Supply customer birthday to match with document

verifyAge

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.

verifyAddress

string

Supply customer address to match with document

verifyPostcode

string

Supply customer postcode to match with document

verifyDocumentNumber

string

Supply customer ID number to match with document

contractGenerate

string

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

contractFormat

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.

customData

string

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

Responses

200Representative response payload for the ID Verification API and Quick Scan API. The example includes extracted OCR fields, validation warnings, decision data, output images, and generated files so developers can understand how a production verification response is structured.

400Bad Request

401Unauthorized