Returns the status of the document verification as its being processed by the vendor.
POST {{baseUrl}}/document-verifications/document-data-retrievals
Informs if the document verification is still being processed or is
processed already. If SUCCESS, the document data is returned.
This API is mandatory.
Request Body
{"countryCode"=>"US", "workflowId"=>"df52649e-4096-456a-bca0-751ee470009f", "userConsent"=>"ACCEPT", "userProfileId"=>"df52649e-4096-456a-bca0-751ee470009f", "locale"=>"en-US", "userSelectedCountry"=>"USA", "documentType"=>"PASSPORT", "privacyPolicyVersion"=>"1.0.0", "sdkAuditEvents"=>[{"dateTime"=>"2020-01-28T13:16:01.714-05:00", "softwareVersion"=>"1.0.0", "userProfileId"=>"df52649e-4096-456a-bca0-751ee470009f", "sessionId"=>"123ae1aa-6744-433e-879d-7da48d631234", "transactionGroupId"=>"28eae1aa-6744-433e-879d-7da48d63e89a", "logRequestFlow"=>"CoreSDK-TP", "logEvent"=>"ID Enrollment", "logEventType"=>"User Profile Creation", "osVersion"=>"Android 5.0", "deviceMake"=>"Samsung S10", "type"=>"audit", "audit"=>{"privacyPolicy"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "userBiometricConsent"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "event"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "eventType"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "result"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "eventGeneratedSource"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "owner"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "requestDetails"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "responseDetails"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, {"dateTime"=>"2020-01-28T13:16:01.714-05:00", "softwareVersion"=>"1.0.0", "userProfileId"=>"df52649e-4096-456a-bca0-751ee470009f", "sessionId"=>"123ae1aa-6744-433e-879d-7da48d631234", "transactionGroupId"=>"28eae1aa-6744-433e-879d-7da48d63e89a", "logRequestFlow"=>"CoreSDK-TP", "logEvent"=>"ID Enrollment", "logEventType"=>"User Profile Creation", "osVersion"=>"Android 5.0", "deviceMake"=>"Samsung S10", "type"=>"audit", "audit"=>{"privacyPolicy"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "userBiometricConsent"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "event"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "eventType"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "result"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "eventGeneratedSource"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "owner"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "requestDetails"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "responseDetails"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}], "tpAuditMetadata"=>{"sessionId"=>"be3ad617-04ad-43e1-a438-79425b6511b6", "transactionGroupId"=>"be3ad617-04ad-43e1-a438-79425b6511b6"}, "arid"=>"a15fa6de-b199-11eb-8529-0242ac130003", "sdkVersion"=>"2.3.0"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Encrypted-Payload | boolean | An indicator that the request is encrypted or indicates that the client is able to receive an encrypted response. If not set, the payload will be treated as plaintext. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"documentData":{"addressLine1":"36271 GrandRiver Ave","addressLine2":"Building no 2","addressZipCode":"48335","addressCity":"Farmington","addressSubdivision":"MO","addressCountry":"USA","lastName":"Doe","firstName":"John","dateOfBirth":"1996-07-10","issuingCountry":"USA","issuingDate":"1996-07-10","expiryDate":"1996-07-10","gender":"M","fathersName":"John Smith","mothersName":"Paula Smith","documentNumber":"1LViI488YkFZh8YjNlLf61BMn29cmQn","documentType":"passport","issuingPlace":"New York","issuingAuthority":"United States","placeOfBirth":"Boston","issuingState":"MO","formattedAddress":"220 BLVD O FALLON MO","rgNumber":"12345","cpf":"12345","cardNumber":"C876687JK","documentStatus":"SUCCESS"},"status":"SUCCESS","transactionId":"1ec14310-e85c-11ea-adc1-0242ac120002"}