Document Liveness API
Introduction
Ensure the integrity of your identity verification process with the Document Liveness API. This powerful tool verifies that a document is a genuine, physical item present at the time of capture, providing a critical security layer against fraudulent submissions. By analyzing the document image, the API detects sophisticated presentation attacks, ensuring the document is authentic and has not been tampered with, thereby protecting your platform from a wide range of fraud.
Our API provides comprehensive protection by defending against four key attack vectors: Screen Replay (detecting images displayed on digital screens), Portrait Substitution (identifying altered photos on a document), Digital Manipulation (finding evidence of software-based editing), and Printed Copy attacks (distinguishing original documents from high-quality replicas). Integrating this API will significantly strengthen your security and build a more trustworthy environment for your users. This API takes in Image / Document URL encrypted image as an input. Users also have option to select or deselect models based on their requirements.
API details
Endpoint
https://api.signzy.app/api/v3/document/livenessPOST https://api-preproduction.signzy.app/api/v3/document/livenessRequest headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Input parameters
Name | Value | Required | Description |
|---|---|---|---|
image | String | Mandatory | URL of image to be checked |
digitalManipulation | Boolean | Mandatory | Select true if want to check for digital manipulation; else false |
screenReplayAttack | Boolean | Mandatory | Select true if want to check for screen replay; else false |
portraitSubstitution | Boolean | Mandatory | Select true if want to check for portrait substitutuion; else false |
printed-copy | Boolean | Mandatory | Select true if want to check for printed copy; else false |
{
"image": "<Persist-URL>",
"digitalManipulation": true,
"screenReplayAttack":false,
"portraitSubstituition": false,
"printed-copy": true
}Code samples
curl --location 'https://api-preproduction.signzy.app/api/v3/document/liveness' \
--header 'Content-Type: application/json' \
--header 'Authorization: <authkey>' \
--data '{
"image": "<Persist-URL>",
"digitalManipulation": true,
"screenReplayAttack":false,
"portraitSubstituition": false,
"printed-copy": true
}'
Response body parameters
Parameter | Data Type | Description |
|---|---|---|
results | Array of objects | List of models included in the output result, selected true |
results[i].model | String | Name of the model selected |
results[i].result. livenessProbability | Number | Probability score for liveness between 0 and 1 for the image based on model exclusively |
results[i].result.statusCode | String | Shows error if document not detected, else shows "OK" |
aggregateLivenessProbability | Number | Final liveness score for document based on individual results with selected models |
{
"results": [
{
"model": "digitalManipulation",
"result": {
"livenessProbability": 0.444799,
"statusCode": "OK"
}
},
{
"model": "printedCopy",
"result": {
"livenessProbability": 0,
"statusCode": "OK"
}
}
],
"aggregateLivenessProbability": 0
}Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!