Returns the status of the document verification with Details.
GET {{baseUrl}}/data-extractions/scans-details/:scan_id?user_consent=ACCEPT&retrieve_selfie=true&retrieve_document_images=true&retrieve_facemap=true&document_type=DRIVING_LICENSE&user_selected_country=USA&workflowDefinition=DOCUMENT_EXTRACTION_FACEMATCH_LIVENESS
Returns the status of the document verification as it's being processed by the vendor.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
user_consent | string | (Required) The value which best reflects the input of the User with regard to Consent to use their data (ACCEPT, DECLINE, REVOKE, EXPIRE). | |
retrieve_selfie | boolean | (Required) Flag indicating if the selfie needs to be retrieved. | |
retrieve_document_images | boolean | (Required) Flag indicating if the document images needs to be retrieved. | |
retrieve_facemap | boolean | (Required) Flag indicating if the facemap needs to be retrieved. | |
document_type | string | The type of document scanned (DRIVING_LICENSE, PASSPORT, ID_CARD). | |
user_selected_country | string | The ISO 3166-1 alpha3 code which corresponds to the country from where the request to ID is originating from. | |
workflowDefinition | string | worklflow definition parameter |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Encrypted-Payload | boolean | Whether the request payload is encrypted with the Encyption Key generated from the Developer Zone Portal. | |
Accept | string |
RESPONSES
status: OK
{"status":"SUCCESS","transactionId":"1ec14310-e85c-11ea-adc1-0242ac120002","documentData":{"documentNumber":"AB001234567","documentStatus":"SUCCESS","documentType":"DRIVER_LICENSE","dateOfBirth":"2020-09-09","firstName":"MIRIAM","lastName":"Smith","expiryDate":"2020-10-10","gender":"F","cardNumber":"1234567890","issuingCountry":"AUS","issuingDate":"2020-09-09","issuingPlace":"Sydney","issuingAuthority":"Australia","placeOfBirth":"Sydney","addressLine1":"10 Boronia Street","addressLine2":"09 Boronia Street","addressZipCode":"10021","addressCity":"SYDNEY","addressCountry":"Users Country","addressSubdivision":"NSW","issuingState":"NSW","formattedAddress":"22 Melville Street, Hobart 7000","selfie":"/mJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanq.........................","documentImageFront":"/mJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanq.........................","documentImageBack":"/mJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanq.........................","facemap":"/mJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanq........................."}}