ID Liveness
ID Liveness API
Verify the authenticity of ID documents by analyzing images for tampering or forgery
POST
Python
The ID Liveness API section allows users to verify the authenticity of an ID document by analyzing the provided image for signs of tampering or forgery. Users can leverage different pipelines to detect screen captures, printed copies, and portrait replacements, ensuring the integrity of the ID document. Upon completion, users will receive recognition results and transaction information, facilitating secure identity verification processes.
Request notes
- Set
idImageto the bytes of the image file encoded as a base64 string. Send only the encoded string, without a prefix such asdata:image/png;base64,. sr,pc, andpsinpipelinesare all required and must be boolean values.- If you include
callbackUrl, the request is processed asynchronously and the result is delivered to that URL. To receive the result directly in the response, omitcallbackUrl. - When testing in the playground, paste the same base64 string into the
idImagefield.
Response Attributes
Returns detection scores for each pipelines.Pipelines Values:
screenReplay- liveness_scorepaperPrinted- liveness_scorereplacePortraits- liveness_score
Identifies the specific error for troubleshooting.Error Code Values:
1001- Workspace is unavailable1003- Fail to process data1005- idImage is required1007- pipelines is required1008- invalid pipelines format1009- Fail to analyze document1010- callbackUrl is required
Related documents
ID Liveness Overview
Learn about ID Liveness API for detecting document authenticity
Best Practice for Image
Guidelines for optimal image quality and requirements for ID Liveness API
Callback Response Example
Sample responses for ID Liveness API callback interactions
Body
application/json
