ID Proofing

ID Proofing controllers

📄️ 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: <ul><li>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. </li><li>deviceCheckResult: a String value. Allowed operator: EQUALS. Allowed values: ALLOW, DENY, NONE, REVIEW.</li><li>state: a String value. Allowed operator: EQUALS. Allowed values: COMPLETE, DEVICE, IMAGE, INIT.</li><li>documentAuthenticationResult: a String value. Allowed operator: EQUALS. Allowed values: NONE, UNKNOWN, PASSED, FAILED, SKIPPED, ATTENTION.</li><li>faceMatch: true or false. Allowed operator: EQUALS. </li></ul>If you provide more than one search attribute, they are joined with an AND condition.<br/><br/>The orderByAttribute supports these attribute names: requestTime, deviceCheckResult, state, documentAuthenticationResult, faceMatch.<br/>

📄️ Initiates an ID Proofing request, checks the risk of a device and obtains license details

Caller requires the IDPROOFING:ADD permission.

📄️ Gets an ID Proofing request

Gets an ID Proofing request. Caller requires the IDPROOFING:VIEW permission.

📄️ 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.

📄️ 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.

📄️ Upload an ID Document image (binary)

Uploads the front (side = 0) or back (side = 1) of an ID document.