ID Liveness API
The ID Liveness API verifies the authenticity of ID images through several checks. It includes forgery detection options and pipelines to detect screen captures, printed copies, and tampered face images. Upon successful processing, a response is sent to a specified callback URL, ensuring verification for identity authentication.
If your organization or service maintains stric security policies by denying access to most or all external websites, it's likely you'll need to add our static IP to a whitelist.
Please request [email protected] to Whitelist IP Address
Supported Image Restrictions
Supported File Formats : JPEG, JPG, PNG, BMP
File Size Limit : Each image must be under 5MB
Minimum Resolution : Full HD (FHD) or 1080p: 1920x1080 pixels
Maximum Compression : Single Compression JPEG 70 (however, uncompressed images are recommended)
statusCode number
Status Code for the API request result
apiType string
API type
transactionId string
Unique identifier for each request
result object
Object containing the processing result
result.screenReplay object
Object containing the result of the Screen Replay pipeline
result.screenReplay.liveness_score number
Liveness Score result of the Screen Replay check
result.paperPrinted object
Object containing the result of the Paper Printed pipeline
result.paperPrinted.liveness_score number
Liveness Score result of the Paper Printed check
result.replacePortraits object
Object containing the result of the Replace Portraits pipeline
result.replacePortraits.livenss_score
Liveness Score result of the Replace Portraits check
1001
Workspace is unavailable
1003
Fail to process data
1010
callbackUrl is required
1005
idImage is required
1007
pipelines is required
1008
invalid pipelines format
1009
Fail to analyze document