After the Verification process is done on the user side, you can request the Document Verification result by calling the Get Result API.
Request Example:
curl -X POST \ https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result \ -H 'Content-Type: application/json' \ -H 'X-ACCESS-TOKEN:{Your Access Token}' \ -d '{"signatureId": "f302f5d2454a85c2"}'
https://my-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result POST (application/json)
| Parameter | Description |
|---|---|
| X-ACCESS-TOKEN | string Please use Token Authentication API to get your access token |
| Parameter | Description |
|---|---|
| signatureId | string SignatureId which can use it to get the Verification result |
| Parameter | Description |
|---|---|
| code | Response's Status Code |
| transactionId | The request id, the max length is 64 |
| pricingStrategy | Deprecated, Always return FREE |
| message | Status Code Explanation |
| data | object : the business result of Verification |
| extra | Extra response info (Exception Message) |
| Status Code | Message |
|---|---|
| SUCCESS | OK |
| SIGNATURE_NOT_EXIST | This signatureId is not exist. |
| ERROR | Server error. |
| Field | Description |
|---|---|
| signatureId | string, the signatureId of this verification transaction. |
| idvResult | string, The result code of this verification transaction. |
| errorCode | string, The fail reason when eckyResult is fail |
| docDetail | object, The document verification result details.Refer to DocDetail |
idvResult is the result code of the verification
| Value | Description |
|---|---|
| PASS | the user passed the verification check. |
| FAIL | the user failed the verification check. |
| INCOMPLETE | the user gave up in the middle of the verification check, or the user timeouts. |
errorCode
| Response.data.idvResult | Value | Description |
|---|---|---|
| PASS | SUCCESS | The user passed the verification. |
| FAIL | NO_FACE_DETECTED | No face detected on the front image of the document. |
| CARD_INFO_MISMATCH | The front part and the back part of the two-side document do not match with each other. | |
| ID_FORGERY_DETECTED | The document ( only the front part if the document is two-side) is forgery. | |
| STRATEGY_HIT | Security policy hit | |
| INCOMPLETE (FAIL when solutionCode in ["05"]) |
NO_SUPPORTED_CARD | The card type detected from the document image is not supported. |
| CARD_TYPE_MISMATCH | The card type detected from the document image doesn't match with the docType from the Generate URL API |
|
| CARD_LOW_QUALITY_IMAGE | The document images are too poor to do verification. | |
| INCOMPLETED_CARD | The card is not completed in the document images. | |
| TOO_MANY_CARDS | More than one cards were detected. | |
| CARD_NOT_FOUND | Can't detect card from the document image. | |
| OCR_NO_RESULT | Can't extract ocr result from the docImages | |
| PARAMETER_ERROR | the data submitted by our frontend is not valid. this may indicates a frontend bug. | |
| USER_TIMEOUT | User did not complete the operation within the specified time（1 hour） | |
| ERROR | Error during processing in our backend. this may indicates a backend bug. | |
| NO_SUPPORTED_CARD_CUSTOMIZED | The card type is known but not supported currently. maybe support in the future. |
Comments
0 comments