Send liveness check transaction data and performs a face match with the ID Document photo image.
PUT/api/web/v1/idproofing/:requestId/complete
Returns the document authentication result and the face match result. This ID Proofing API call consumes two transactions and the ID Proofing request status is marked as COMPLETED. Any subsequent ID Proofing API calls using the same requestId will return an error. Caller requires the IDPROOFING:EDIT permission.
Request
Path Parameters
The UUID of the ID Proofing request.
- application/json
Body
required
A token identifying the liveness transaction.
User ID to use for the liveness transaction.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Possible values: [UNKNOWN
, PASSED
, FAILED
, SKIPPED
, ATTENTION
]
The ID document authentication result.
documentDataFields
object[]
The list of fields extracted from the ID document.
The data field description.
The data field name.
Possible values: [STRING
, BOOLEAN
, DATETIME
]
The data type of data field value .
The data field value extracted from the ID document.
documentTestResults
object[]
The result of individual tests performed on the ID document.
A longer description with possible actions to performed on the document.
The description of the check performed on the document.
A short description with result of the check performed on the document.
A longer description with result of the check performed on the document.
Identifies the check performed.
Possible values: [UNKNOWN
, PASSED
, FAILED
, SKIPPED
, CAUTION
, ATTENTION
]
The ID classification result.
Returns true if the document photo and the selfie image matched.
Face match score normalized to the range 0-100, where 80 or higher is considered a match. Clients should rely on the isFaceMatch property rather than the raw score.
{
"documentAuthenticationResult": "ATTENTION",
"documentDataFields": [
{
"description": "The middle name of the bearer of the document.",
"name": "Middle Name",
"type": "STRING",
"value": "JANE"
}
],
"documentTestResults": [
{
"actions": "The expiration date on the document may have been misread. Confirm that it is legible and occurs on or after the current date. Also confirm that the current date and time of the host computer is correctly set.",
"description": "Checked if the document is expired.",
"disposition": "The document has expired.",
"information": "Verified that the birth date is valid, in the expected format, and occurs on or before the current date and not outside a reasonable range.",
"name": "Document Expired",
"result": "PASSED"
}
],
"faceMatch": true,
"faceMatchScore": 85
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}