Skip to main content
POST
/
document
ID Liveness Detection
curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/document \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idImage": "base64_encoded_id_document_image",
  "pipelines": {
    "sr": true,
    "pc": true,
    "ps": true
  },
  "useUpcomingVersion": true,
  "callbackUrl": "https://your-domain.com/callback"
}
'
{
  "apiType": "id_live_doc",
  "transactionId": "txn_123456789",
  "engineVersion": "id_liveness@3.4.2",
  "result": {
    "screenReplay": {
      "liveness_score": 99
    },
    "paperPrinted": {
      "liveness_score": 82
    },
    "replacePortraits": {
      "liveness_score": 100
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

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.
Notes
To properly verify the authenticity of an image, whitespace around the ID is required.
If the ID fills the entire image without any whitespace, accurate results may not be produced.
Example image:

​
Response Attributes

​
transactionId
string
Unique identifier for the transaction associated with the recognition request.
​
result
string
Returns detection scores for each pipelines.Pipelines Values:
  • screenReplay - liveness_score
  • paperPrinted - liveness_score
  • replacePortraits - liveness_score
​
errorCode
string
Identifies the specific error for troubleshooting.Error Code Values:
  • 1001 - Workspace is unavailable
  • 1003 - Fail to process data
  • 1005 - idImage is required
  • 1007 - pipelines is required
  • 1008 - invalid pipelines format
  • 1009 - Fail to analyze document
  • 1010 - callbackUrl is required
​
message
string
Briefly describes the error. Please refer to the error code for details.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
idImage
file
required

Base64 encoded ID document image to analyze for liveness detection. The image should contain a clear view of the ID document.

​
pipelines
object
required

Forgery detection options object

​
useUpcomingVersion
boolean
default:False

Use the upcoming version of the liveness engine

​
callbackUrl
string<uri>

Optional callback URL where the liveness detection results will be sent upon completion. If provided, the process works asynchronously.

Example:

"https://your-domain.com/callback"

Response

Successful liveness detection analysis

​
apiType
string
Example:

"id_live_doc"

​
transactionId
string

Unique transaction identifier

Example:

"txn_123456789"

​
engineVersion
string

Liveness Engine's version for each request

Example:

"id_liveness@3.4.2"

​
result
object