Get Result API
After the Verification process is done on the user side, you can request the 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"}'Request Url
https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-result
POST (application/json)Request Header Parameters
| Parameter | Description |
|---|---|
| X-ACCESS-TOKEN | string Please use Token Authentication API to get your access token |
Request Parameters
| Parameter | Description |
|---|---|
| signatureId | string SignatureId which can use it to get the Verification result |
Response Description
| 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) |
Response.code
| Status Code | Message |
|---|---|
| SUCCESS | OK |
| SIGNATURE_NOT_EXIST | This signatureId is not exist. |
| ERROR | Server error. |
Response.data
Field | Description |
|---|---|
signatureId |
|
overallResult |
|
idvResult |
|
errorCode |
|
docDatabaseDetail |
|
faceDetail |
|
inputParameters |
Generate URL API's input. Refer to InputParameters |
countryCodeIso3 |
's input. |
overallResult
overallResult 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.overallResult | Value | Description |
|---|---|---|
| PASS | SUCCESS | The user passed the verification. |
| FAIL | BVN_NOT_EXIST | the BVN inputed by the user doesn't exists. |
| BVN_SUSPEND | The ID has been restricted from use by the official institution. The user should go to the relevant department to handle the recover procedures. | |
| NUMBER_NOT_EXIST | The number inputed by user doesn't exists. | |
| NAME_NOT_MATCH | Name inputed by user is not match. | |
| LIVENESS_ATTACK | The liveness check failed. | |
| SIMILARITY_FAILED | The liveness face and the face belong to the number are not considered as the same person. | |
| STRATEGY_HIT | Security policy hit. （Deprecated) | |
| RISK_STRATEGY_HIT | The transaction has triggered risk prevention strategies that are used to reject attacks. | |
| INCOMPLETE | BVN_INVALID_FORMAT | The BVN number inputed by user is in wrong format. |
| INVALID_FORMAT | The Number or other fields inputed by user is in wrong format. | |
| PARAMETER_ERROR | the data submitted by our frontend is not valid. this may indicates a frontend bug. | |
| BVN_DATASOURCE_UNSTABLE | bvn datasource is unstable to complete the bvn verification. | |
| DATASOURCE_UNSTABLE | datasource is unstable to complete the number verification. | |
| 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. | |
| FACE_QUALITY_TOO_POOR | Face quality too poor for face comparison or liveness. |
Response Examples
SUCCESS
{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "f302f5d2454a85c2",
"overallResult": "PASS",
"idvResult": "PASS",
"errorCode": "SUCCESS",
"docDatabaseDetail": {
"bvn": "22********4",
"firstName": "T****E",
"middleName": "C****T",
"lastName": "I***A",
"gender": "FEMALE",
"birthday": "1994/07/13",
"phoneNumber": "081******05",
"phoneNumber2": ""
},
"faceDetail": {
"faceResult": "PASS",
"faceImageFar": "https://abc.com/faceImageFar.jpg",
"faceImageNear": "https://abc.com/faceImageNear.jpg",
"auditImageUrl": "https://abc.com/auditImage.zip",
"faceLivenessScore": 99,
"faceSimilarityScore": 82,
"eventDetails": [
{
"event": "FE_DOCUMENT_SCAN",
"result": "PASS",
"createTimestmap": 1665993522952
}
]
},
"inputParameters": {
"returnUrl": "https://www.example.com",
"failReturnUrl": "https://www.example.com/fail",
"callbackUrl": "https://www.example.com/callback",
"bizId": "7ac66c0f148de9519b8bd264312c4d64",
"userId": "8e44f0089b076e18a718eb9ca3d94674",
"region": "NGA",
"numberType": "BVN",
"language": "en-US",
"prefersColorScheme": "light",
"ignoreFailWhenJump": false,
"bizCode": "WhiteCard"
},
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226"
}{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "f302f5d2454a85c2",
"overallResult": "FAIL",
"idvResult": "FAIL",
"errorCode": "LIVENESS_ATTACK",
"docDatabaseDetail": {
"bvn": "22********4",
"firstName": "T****E",
"middleName": "C****T",
"lastName": "I***A",
"gender": "FEMALE",
"birthday": "1994/07/13",
"phoneNumber": "081******05",
"phoneNumber2": ""
},
"faceDetail": {
"faceResult": "FAIL",
"faceImageFar": "https://abc.com/faceImageFar.jpg",
"faceImageNear": "https://abc.com/faceImageNear.jpg",
"auditImageUrl": "https://abc.com/auditImage.zip",
"faceLivenessScore": 0,
"faceSimilarityScore": null,
"eventDetails": [
{
"event": "FE_DOCUMENT_SCAN",
"result": "PASS",
"createTimestmap": 1665993522952
}
]
},
"inputParameters": {
"returnUrl": "https://www.example.com",
"failReturnUrl": "https://www.example.com/fail",
"callbackUrl": "https://www.example.com/callback",
"bizId": "7ac66c0f148de9519b8bd264312c4d64",
"userId": "8e44f0089b076e18a718eb9ca3d94674",
"region": "NGA",
"numberType": "BVN",
"language": "en-US",
"prefersColorScheme": "light",
"ignoreFailWhenJump": false,
"bizCode": "WhiteCard"
},
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226"
}NGN BVN/NIN
{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "f302f5d2454a85c2",
"overallResult": "FAIL",
"idvResult": "FAIL",
"errorCode": "BVN_NOT_EXIST",
"docDatabaseDetail": null,
"faceDetail": null,
"inputParameters": {
"returnUrl": "https://www.example.com",
"failReturnUrl": "https://www.example.com/fail",
"callbackUrl": "https://www.example.com/callback",
"bizId": "7ac66c0f148de9519b8bd264312c4d64",
"userId": "8e44f0089b076e18a718eb9ca3d94674",
"region": "NGA",
"numberType": "BVN",
"language": "en-US",
"prefersColorScheme": "light",
"ignoreFailWhenJump": false,
"bizCode": "WhiteCard"
},
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226"
}{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "f302f5d2454a85c2",
"overallResult": "INCOMPLETE",
"idvResult": "INCOMPLETE",
"errorCode": "BVN_INVALID_FORMAT",
"docDatabaseDetail": null,
"faceDetail": null,
"inputParameters": {
"returnUrl": "https://www.example.com",
"failReturnUrl": "https://www.example.com/fail",
"callbackUrl": "https://www.example.com/callback",
"bizId": "7ac66c0f148de9519b8bd264312c4d64",
"userId": "8e44f0089b076e18a718eb9ca3d94674",
"region": "NGA",
"numberType": "BVN",
"language": "en-US",
"prefersColorScheme": "light",
"ignoreFailWhenJump": false,
"bizCode": "WhiteCard"
},
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226"
}IDN NIK
{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "ab69**********0e",
"overallResult": "FAIL",
"idvResult": "FAIL",
"errorCode": "NAME_NOT_MATCH",
"faceDetail": {
"faceResult": "FAIL",
"faceImageFar": "https://stg-guardian-cv.oss-ap-southeast-5.aliyuncs.com/REDACTED",
"faceImageNear": "https://stg-guardian-cv.oss-ap-southeast-5.aliyuncs.com/REDACTED",
"auditImageUrl": null,
"faceLivenessScore": null,
"faceSimilarityScore": null,
"eventDetails": [],
"faceImageFarTime": 1756375677000,
"faceImageNearTime": 1756375677000,
"livenessAttackType": null,
"faceImage": null,
"faceImageTimestamp": null,
"livenessType": "DISTANT_NEAR",
"livenessFlowCategory": "DISTANT_CLOSE"
},
"docDetail": {
"ocrResult": null,
"docFrontImage": null,
"docBackImage": null,
"originDocType": null,
"docType": null,
"subDocType": null,
"ocrInfo": null,
"qualityIsLow": null,
"qualityLabels": null,
"forgeryLabels": null,
"eventDetails": [],
"docTypeDetails": {
"front": null,
"back": null
},
"docFrontImageTime": null,
"docBackImageTime": null
},
"docDatabaseDetail": {
"bvn": null,
"nin": null,
"numberValue": "************0005",
"numberTypeInfo": {
"numberType": "ID_NIK",
"region": "IDN"
},
"firstName": null,
"middleName": null,
"lastName": null,
"fullName": "R**** I**********",
"gender": "FEMALE",
"birthday": "1976/**/**",
"phoneNumber": "+62*******4455",
"phoneNumber2": null,
"email": "w*****c@***.com",
"verification": {
"numberValue": "pass",
"fullName": "fail",
"dob": "fail",
"face": "fail"
}
},
"inputParameters": {
"bizId": "02f1**********83",
"returnUrl": "https://www.baidu.com/",
"failReturnUrl": "https://m.weibo.cn/",
"callbackUrl": null,
"userId": "****3456",
"region": "IDN",
"language": null,
"prefersColorScheme": "light",
"numberType": "NIK",
"ignoreFailWhenJump": false,
"bizCode": null,
"iframeEnabled": false,
"livenessType": "DISTANT_NEAR",
"productLevel": null,
"docType": null
},
"countryCodeIso3": "IDN",
"productLevel": "CUSTOMIZED"
},
"extra": null,
"pricingStrategy": "FREE"
}{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "fd51**********d6",
"overallResult": "INCOMPLETE",
"idvResult": "INCOMPLETE",
"errorCode": "PARAMETER_ERROR",
"faceDetail": {
"faceResult": "INCOMPLETE",
"faceImageFar": "https://stg-guardian-cv.oss-ap-southeast-5.aliyuncs.com/REDACTED",
"faceImageNear": "https://stg-guardian-cv.oss-ap-southeast-5.aliyuncs.com/REDACTED",
"auditImageUrl": null,
"faceLivenessScore": null,
"faceSimilarityScore": null,
"eventDetails": [],
"faceImageFarTime": 1756375667000,
"faceImageNearTime": 1756375667000,
"livenessAttackType": null,
"faceImage": null,
"faceImageTimestamp": null,
"livenessType": "DISTANT_NEAR",
"livenessFlowCategory": "DISTANT_CLOSE"
},
"docDetail": {
"ocrResult": null,
"docFrontImage": null,
"docBackImage": null,
"originDocType": null,
"docType": null,
"subDocType": null,
"ocrInfo": null,
"qualityIsLow": null,
"qualityLabels": null,
"forgeryLabels": null,
"eventDetails": [],
"docTypeDetails": {
"front": null,
"back": null
},
"docFrontImageTime": null,
"docBackImageTime": null
},
"docDatabaseDetail": {
"bvn": null,
"nin": null,
"numberValue": "************0005",
"numberTypeInfo": {
"numberType": "ID_NIK",
"region": "IDN"
},
"firstName": null,
"middleName": null,
"lastName": null,
"fullName": "R**** I******",
"gender": null,
"birthday": null,
"phoneNumber": "+62*******4455",
"phoneNumber2": null,
"email": "w*****c@***.com",
"verification": {
"numberValue": null,
"fullName": null,
"dob": null,
"face": null
}
},
"inputParameters": {
"bizId": "02f1**********83",
"returnUrl": "https://www.baidu.com/",
"failReturnUrl": "https://m.weibo.cn/",
"callbackUrl": null,
"userId": "****3456",
"region": "IDN",
"language": null,
"prefersColorScheme": "light",
"numberType": "NIK",
"ignoreFailWhenJump": false,
"bizCode": null,
"iframeEnabled": false,
"livenessType": "DISTANT_NEAR",
"productLevel": null,
"docType": null
},
"countryCodeIso3": "IDN",
"productLevel": "CUSTOMIZED"
},
"extra": null,
"pricingStrategy": "FREE"
}{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId": "a32e**********ee",
"overallResult": "PASS",
"idvResult": "PASS",
"errorCode": "SUCCESS",
"faceDetail": {
"faceResult": "PASS",
"faceImageFar": "https://stg-guardian-cv.oss-ap-southeast-5.aliyuncs.com/REDACTED",
"faceImageNear": "https://stg-guardian-cv.oss-ap-southeast-5.aliyuncs.com/REDACTED",
"auditImageUrl": null,
"faceLivenessScore": 100.0,
"faceSimilarityScore": null,
"eventDetails": [],
"faceImageFarTime": 1756375621000,
"faceImageNearTime": 1756375621000,
"livenessAttackType": null,
"faceImage": null,
"faceImageTimestamp": null,
"livenessType": "DISTANT_NEAR",
"livenessFlowCategory": "DISTANT_CLOSE"
},
"docDetail": {
"ocrResult": null,
"docFrontImage": null,
"docBackImage": null,
"originDocType": null,
"docType": null,
"subDocType": null,
"ocrInfo": null,
"qualityIsLow": null,
"qualityLabels": null,
"forgeryLabels": null,
"eventDetails": [],
"docTypeDetails": { "front": null, "back": null },
"docFrontImageTime": null,
"docBackImageTime": null
},
"docDatabaseDetail": {
"bvn": null,
"nin": null,
"numberValue": "************0005",
"numberTypeInfo": { "numberType": "ID_NIK", "region": "IDN" },
"firstName": null,
"middleName": null,
"lastName": null,
"fullName": "R**** I******",
"gender": "FEMALE",
"birthday": "1976/**/**",
"phoneNumber": "+62*******4455",
"phoneNumber2": null,
"email": "w*****c@***.com",
"verification": { "numberValue": "pass", "fullName": "pass", "dob": "fail", "face": "pass" }
},
"inputParameters": {
"bizId": "02f1**********83",
"returnUrl": "https://www.baidu.com/",
"failReturnUrl": "https://m.weibo.cn/",
"callbackUrl": null,
"userId": "****3456",
"region": "IDN",
"language": null,
"prefersColorScheme": "light",
"numberType": "NIK",
"ignoreFailWhenJump": false,
"bizCode": null,
"iframeEnabled": false,
"livenessType": "DISTANT_NEAR",
"productLevel": null,
"docType": null
},
"countryCodeIso3": "IDN",
"productLevel": "CUSTOMIZED"
},
"extra": null,
"pricingStrategy": "FREE"
}SIGNATURE_NOT_EXIST
{
"code":"SIGNATURE_NOT_EXIST",
"message":"This signatureId is not exist",
"data":null,
"extra":null,
"transactionId":"b6d722f7e9f553ae"
}ERROR
{
"code":"ERROR",
"message":"Server error",
"data":null,
"extra":null,
"transactionId":"1deae5a13ef2bd5e"
}Updated about 1 month ago