IDProofingApi
| Method | HTTP request | Description |
|---|---|---|
| id_proofing_complete_selfie_using_put | PUT /api/web/v1/idproofing/{requestId}/completeselfie | Upload a selfie image and performs a face match with the ID Document photo image. |
| id_proofing_complete_using_put | PUT /api/web/v1/idproofing/{requestId}/complete | Send liveness check transaction data and performs a face match with the ID Document photo image. |
| id_proofing_image_using_put | PUT /api/web/v1/idproofing/{requestId}/image/{side} | Upload an ID Document image (binary) |
| id_proofing_init_using_post | POST /api/web/v1/idproofing/init | Initiates an ID Proofing request, checks the risk of a device and obtains license details |
| id_proofing_request_using_get | GET /api/web/v1/idproofing/{requestId} | Gets an ID Proofing request |
| id_proofing_requests_paged_using_post | POST /api/web/v1/idproofing | Lists a page of ID Proofing requests |
id_proofing_complete_selfie_using_put
IdProofingAuthenticationResult id_proofing_complete_selfie_using_put(request_id, body)
Upload a selfie image and performs a face match with the ID Document photo image.
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.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| request_id | str | The UUID of the ID Proofing request. | |
| body | bytearray |
Return type
IdProofingAuthenticationResult
Authorization
HTTP request headers
- Content-Type: application/octet-stream
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
id_proofing_complete_using_put
IdProofingAuthenticationResult id_proofing_complete_using_put(request_id, id_proofing_complete_parms)
Send liveness check transaction data and performs a face match with the ID Document photo image.
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.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| request_id | str | The UUID of the ID Proofing request. | |
| id_proofing_complete_parms | IdProofingCompleteParms |
Return type
IdProofingAuthenticationResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
id_proofing_image_using_put
IdProofingDocumentClassification id_proofing_image_using_put(request_id, side, body)
Upload an ID Document image (binary)
Uploads the front (side = 0) or back (side = 1) of an ID document. Caller requires the IDPROOFING:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| request_id | str | The UUID of the ID Proofing request. | |
| side | int | The side of the ID document image. | |
| body | bytearray |
Return type
IdProofingDocumentClassification
Authorization
HTTP request headers
- Content-Type: application/octet-stream
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
id_proofing_init_using_post
IdProofingInitResult id_proofing_init_using_post(id_proofing_init_parms)
Initiates an ID Proofing request, checks the risk of a device and obtains license details
Caller requires the IDPROOFING:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id_proofing_init_parms | IdProofingInitParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
id_proofing_request_using_get
IdProofingRequest id_proofing_request_using_get(request_id)
Gets an ID Proofing request
Gets an ID Proofing request. Caller requires the IDPROOFING:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| request_id | str | The UUID of the ID Proofing request. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
id_proofing_requests_paged_using_post
IdProofingRequestPage id_proofing_requests_paged_using_post(search_parms)
Lists a page of ID Proofing requests
Returns ID Proofing requests for the provided search parameters. Caller requires the IDPROOFING:VIEW permission. The following searchByAttributes are supported:
- requestTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- deviceCheckResult: a String value. Allowed operator: EQUALS. Allowed values: ALLOW, DENY, NONE, REVIEW.
- state: a String value. Allowed operator: EQUALS. Allowed values: COMPLETE, DEVICE, IMAGE, INIT.
- documentAuthenticationResult: a String value. Allowed operator: EQUALS. Allowed values: NONE, UNKNOWN, PASSED, FAILED, SKIPPED, ATTENTION.
- faceMatch: true or false. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.
The orderByAttribute supports these attribute names: requestTime, deviceCheckResult, state, documentAuthenticationResult, faceMatch.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |