Quick ID Scan

200

Example response payload for Standard Scan and Quick Scan ID Verification API.

Obtained using the following:
Document Image: https://www.idanalyzer.com/assets/testsample_id.jpg
Face Image: https://www.idanalyzer.com/assets/testsample_face.jpg
KYC Profile: https://www.idanalyzer.com/assets/testprofile.json

You may download the images and import the profile through web portal.

Response body

object

success

boolean

Boolean indicating whether the API request succeeded

transactionId

string

Transaction ID for the current API request, will only be returned if save to cloud is enabled.

data

object

Data contains all the information extracted from the uploaded document

key

array of objects

The key for the extracted data, refer to "Data Fields" page in developer guide for all possible field key.

key

object

value

string

String value of the field

confidence

number

OCR confidence score, lower score indicating blurry text.

source

string

Source of data: "visual", "mrz" or "barcode"

index

integer

0=Front 1=Back

inputBox

array of arrays of integers

length between 4 and 4

Bounding box relative to the uploaded image. Comes in the following order: Top Left, Top Right, Bottom Right, Bottom Left.

inputBox

array of integers

outputBox

array of arrays of integers

length between 4 and 4

Bounding box relative to the output or cropped image. Comes in the following order: Top Left, Top Right, Bottom Right, Bottom Left.

outputBox

array of integers

outputImage

object

If image output is enabled in profile, cropped and obscured image will be produced.

front

string

URL or base64 content to proccessed front document image

back

string

URL or base64 content to processed back document image

face

string

URL or base64 content to processed face image

outputFile

array of objects

Contains a list of additional files generated, eg. Audit report, contracts etc.

outputFile

object

name

string

Description of the file: "Transaction Audit Report" or contract template name and ID.

fileName

string

Unique file name, you may use /filevault API to retrieve the file.

fileUrl

string

URL to download the file

warning

array of objects

Contains a list of failed document validations

warning

object

code

string

Refer to "Validation & Warnings" guide for full list of warning codes.

description

string

Description of warning

severity

string

The severity of the validation failure

confidence

number

Confidence score of the warning bewteen 0 to 1. Some warnings will always return 1.

decision

string

The decision for this particular warning: accept, review or reject, based on your KYC Profile configuration.

data

object

Extra data for AML warnings, will only be returned of an AML validation has failed. Refer to sample JSON response for object structure and data.

missingFields

array of strings

Fields that should be found on the current document but cannot be parsed by the system, possibly too blurry or obscured by user.

missingFields

profileId

string

KYC Profile used for this transaction

reviewScore

integer

Total Review Score based on warnings

rejectScore

integer

Total Reject Score based on warnings

decision

string

Final KYC decision: accept, review or reject

quota

integer

Remaining API quota for your account, you may enable excess usage under web portal to continue calling API even when you have exhausted all your quota.

credit

integer

Remaining test credit for your account, test credits will be consumed before your quota.

customerData

string

Any custom data sent through the customerData parameter when making the request

executionTime

number

Execution time in seconds

400Bad Request

401Unauthorized