Document API
Call this API to do a Document Verification without AAI's Frontend.
Request Example:
curl -X POST \
https://ph-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/document \
-H 'Content-Type: application/json' \
-H 'X-ACCESS-TOKEN:{Your Access Token}' \
-d '{
"callbackUrl": "https://www.example.com/callback",
"bizId": "7ac66c0f148de9519b8bd264312c4d64",
"userId":"8e44f0089b076e18a718eb9ca3d94674",
"region":"THA",
"docType": "TH-ID-N",
"solutionCode": "05",
"frontImageBase64":"YWJjZGVmZw==", // use real image base64 string
"bizCode":"WhiteCard"
}'Request Url
https://th-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/document
POST (application/json)https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/document
POST (application/json)https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/document
POST (application/json)https://vn-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/api/document
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 |
|---|---|
callbackUrl |
|
bizId |
|
userId |
|
region |
|
solutionCode |
|
docType |
|
frontImageBase64 |
|
frontImageUrl |
|
backImageBase64 |
|
backImageUrl |
|
bizCode |
|
solutionCode
the solutionCode determine the product form of the Identity Verification , please choose the product form that suits your needs.
| Supported Values | Product Form |
|---|---|
| 05 | DOCUMENT(API) |
Region and DocType
| Region (Code) | Country & Region | DocType (Input) | SubDocType (output only) | Document Name | Has Back (Two Sides) |
|---|---|---|---|---|---|
| ABW | Aruba | AW-PP-N | AW-PP-N | Passport | No |
| AFG | Afghanistan | AF-PP-N | AF-PP-N | Passport | No |
| AGO | Angola | AO-PP-N | AO-PP-N | Passport | No |
| AIA | Anguilla | AI-PP-N | AI-PP-N | Passport | No |
| ALB | Albania | AL-PP-N | AL-PP-N | Passport | No |
| AND | Andorra | AD-PP-N | AD-PP-N | Passport | No |
| ARE | United Arab Emirates | AE-PP-N | AE-PP-N | Passport | No |
| ARG | Argentina | AR-PP-N | AR-PP-N | Passport | No |
| ARM | Armenia | AM-PP-N | AM-PP-N | Passport | No |
| ATG | Antigua and Barbuda | AG-PP-N | AG-PP-N | Passport | No |
| AUS | Australia | AU-PP-N | AU-PP-N | Passport | No |
| AUT | Austria | AT-PP-N | AT-PP-N | Passport | No |
| AZE | Azerbaijan | AZ-PP-N | AZ-PP-N | Passport | No |
| BDI | Burundi | BI-PP-N | BI-PP-N | Passport | No |
| BEL | Belgium | BE-PP-N | BE-PP-N | Passport | No |
| BEN | Benin | BJ-PP-N | BJ-PP-N | Passport | No |
| BFA | Burkina Faso | BF-PP-N | BF-PP-N | Passport | No |
| BGD | Bangladesh | BD-PP-N | BD-PP-N | Passport | No |
| BGR | Bulgaria | BG-PP-N | BG-PP-N | Passport | No |
| BHR | Bahrain | BH-PP-N | BH-PP-N | Passport | No |
| BHS | Bahamas | BS-PP-N | BS-PP-N | Passport | No |
| BIH | Bosnia and Herzegovina | BA-PP-N | BA-PP-N | Passport | No |
| BLR | Belarus | BY-PP-N | BY-PP-N | Passport | No |
| BLZ | Belize | BZ-PP-N | BZ-PP-N | Passport | No |
| BMU | Bermuda | BM-PP-N | BM-PP-N | Passport | No |
| BOL | Bolivia | BO-PP-N | BO-PP-N | Passport | No |
| BRA | Brazil | BR-PP-N | BR-PP-N | Passport | No |
| BRB | Barbados | BB-PP-N | BB-PP-N | Passport | No |
| BRN | Brunei Darussalam | BN-PP-N | BN-PP-N | Passport | No |
| BTN | Bhutan | BT-PP-N | BT-PP-N | Passport | No |
| BVT | Bouvet Island | BV-PP-N | BV-PP-N | Passport | No |
| BWA | Botswana | BW-PP-N | BW-PP-N | Passport | No |
| CAF | Central African Republic | CF-PP-N | CF-PP-N | Passport | No |
| CAN | Canada | CA-PP-N | CA-PP-N | Passport | No |
| CCK | Cocos (Keeling) Islands | CC-PP-N | CC-PP-N | Passport | No |
| CHE | Switzerland | CH-PP-N | CH-PP-N | Passport | No |
| CHL | Chile | CL-PP-N | CL-PP-N | Passport | No |
| CHN | China | CN-PP-N | CN-PP-N | Passport | No |
| CIV | Côte d'Ivoire | CI-PP-N | CI-PP-N | Passport | No |
| CMR | Cameroon | CM-PP-N | CM-PP-N | Passport | No |
| COD | Democratic Republic of the Congo | CD-PP-N | CD-PP-N | Passport | No |
| COG | Congo | CG-PP-N | CG-PP-N | Passport | No |
| COL | Colombia | CO-PP-N | CO-PP-N | Passport | No |
| COM | Comoros | KM-PP-N | KM-PP-N | Passport | No |
| CPV | Cape Verde | CV-PP-N | CV-PP-N | Passport | No |
| CRI | Costa Rica | CR-PP-N | CR-PP-N | Passport | No |
| CUB | Cuba | CU-PP-N | CU-PP-N | Passport | No |
| CXR | Christmas Island | CX-PP-N | CX-PP-N | Passport | No |
| CYM | Cayman Islands | KY-PP-N | KY-PP-N | Passport | No |
| CYP | Cyprus | CY-PP-N | CY-PP-N | Passport | No |
| CZE | Czech Republic | CZ-PP-N | CZ-PP-N | Passport | No |
| DEU | Germany | DE-PP-N | DE-PP-N | Passport | No |
| DJI | Djibouti | DJ-PP-N | DJ-PP-N | Passport | No |
| DMA | Dominica | DM-PP-N | DM-PP-N | Passport | No |
| DNK | Denmark | DK-PP-N | DK-PP-N | Passport | No |
| DOM | Dominican Republic | DO-PP-N | DO-PP-N | Passport | No |
| DZA | Algeria | DZ-PP-N | DZ-PP-N | Passport | No |
| ECU | Ecuador | EC-PP-N | EC-PP-N | Passport | No |
| EGY | Egypt | EG-PP-N | EG-PP-N | Passport | No |
| ERI | Eritrea | ER-PP-N | ER-PP-N | Passport | No |
| ESP | Spain | ES-PP-N | ES-PP-N | Passport | No |
| EST | Estonia | EE-PP-N | EE-PP-N | Passport | No |
| ETH | Ethiopia | ET-PP-N | ET-PP-N | Passport | No |
| FIN | Finland | FI-PP-N | FI-PP-N | Passport | No |
| FJI | Fiji | FJ-PP-N | FJ-PP-N | Passport | No |
| FLK | Falkland Islands | FK-PP-N | FK-PP-N | Passport | No |
| FRA | France | FR-PP-N | FR-PP-N | Passport | No |
| FRO | Faroe Islands | FO-PP-N | FO-PP-N | Passport | No |
| FSM | Micronesia | FM-PP-N | FM-PP-N | Passport | No |
| GAB | Gabon | GA-PP-N | GA-PP-N | Passport | No |
| GBR | United Kingdom | GB-PP-N | GB-PP-N | Passport | No |
| GEO | Georgia | GE-PP-N | GE-PP-N | Passport | No |
| GHA | Ghana | GH-PP-N | GH-PP-N | Passport | No |
| GIB | Gibraltar | GI-PP-N | GI-PP-N | Passport | No |
| GIN | Guinea | GN-PP-N | GN-PP-N | Passport | No |
| GLP | Guadeloupe | GP-PP-N | GP-PP-N | Passport | No |
| GMB | Gambia | GM-PP-N | GM-PP-N | Passport | No |
| GNB | Guinea-Bissau | GW-PP-N | GW-PP-N | Passport | No |
| GNQ | Equatorial Guinea | GQ-PP-N | GQ-PP-N | Passport | No |
| GRC | Greece | GR-PP-N | GR-PP-N | Passport | No |
| GRD | Grenada | GD-PP-N | GD-PP-N | Passport | No |
| GRL | Greenland | GL-PP-N | GL-PP-N | Passport | No |
| GTM | Guatemala | GT-PP-N | GT-PP-N | Passport | No |
| GUF | French Guiana | GF-PP-N | GF-PP-N | Passport | No |
| GUM | Guam | GU-PP-N | GU-PP-N | Passport | No |
| GUY | Guyana | GY-PP-N | GY-PP-N | Passport | No |
| HKG | Hong Kong | HK-PP-N | HK-PP-N | Passport | No |
| HMD | Heard and McDonald Islands | HM-PP-N | HM-PP-N | Passport | No |
| HND | Honduras | HN-PP-N | HN-PP-N | Passport | No |
| HRV | Croatia | HR-PP-N | HR-PP-N | Passport | No |
| HTI | Haiti | HT-PP-N | HT-PP-N | Passport | No |
| HUN | Hungary | HU-PP-N | HU-PP-N | Passport | No |
| IDN | Indonesia | ID-ID-KTP | ID-ID-KTP | Indonesia National ID | Yes |
| IDN | Indonesia | ID-PP-N | ID-PP-N | Passport | No |
| IND | India | IN-PP-N | IN-PP-N | Passport | No |
| IOT | British Indian Ocean Territory | IO-PP-N | IO-PP-N | Passport | No |
| IRL | Ireland | IE-PP-N | IE-PP-N | Passport | No |
| IRN | Iran | IR-PP-N | IR-PP-N | Passport | No |
| IRQ | Iraq | IQ-PP-N | IQ-PP-N | Passport | No |
| ISL | Iceland | IS-PP-N | IS-PP-N | Passport | No |
| ISR | Israel | IL-PP-N | IL-PP-N | Passport | No |
| ITA | Italy | IT-PP-N | IT-PP-N | Passport | No |
| JAM | Jamaica | JM-PP-N | JM-PP-N | Passport | No |
| JOR | Jordan | JO-PP-N | JO-PP-N | Passport | No |
| JPN | Japan | JP-PP-N | JP-PP-N | Passport | No |
| KAZ | Kazakhstan | KZ-PP-N | KZ-PP-N | Passport | No |
| KEN | Kenya | KE-PP-N | KE-PP-N | Passport | No |
| KGZ | Kyrgyzstan | KG-PP-N | KG-PP-N | Passport | No |
| KHM | Cambodia | KH-PP-N | KH-PP-N | Passport | No |
| KIR | Kiribati | KI-PP-N | KI-PP-N | Passport | No |
| KNA | Saint Kitts and Nevis | KN-PP-N | KN-PP-N | Passport | No |
| KOR | South Korea | KR-PP-N | KR-PP-N | Passport | No |
| KWT | Kuwait | KW-PP-N | KW-PP-N | Passport | No |
| LAO | Laos | LA-PP-N | LA-PP-N | Passport | No |
| LBN | Lebanon | LB-PP-N | LB-PP-N | Passport | No |
| LBR | Liberia | LR-PP-N | LR-PP-N | Passport | No |
| LBY | Libya | LY-PP-N | LY-PP-N | Passport | No |
| LCA | Saint Lucia | LC-PP-N | LC-PP-N | Passport | No |
| LIE | Liechtenstein | LI-PP-N | LI-PP-N | Passport | No |
| LKA | Sri Lanka | LK-PP-N | LK-PP-N | Passport | No |
| LSO | Lesotho | LS-PP-N | LS-PP-N | Passport | No |
| LTU | Lithuania | LT-PP-N | LT-PP-N | Passport | No |
| LUX | Luxembourg | LU-PP-N | LU-PP-N | Passport | No |
| LVA | Latvia | LV-PP-N | LV-PP-N | Passport | No |
| MAC | Macao | MO-PP-N | MO-PP-N | Passport | No |
| MAR | Morocco | MA-PP-N | MA-PP-N | Passport | No |
| MCO | Monaco | MC-PP-N | MC-PP-N | Passport | No |
| MDA | Moldova | MD-PP-N | MD-PP-N | Passport | No |
| MDG | Madagascar | MG-PP-N | MG-PP-N | Passport | No |
| MDV | Maldives | MV-PP-N | MV-PP-N | Passport | No |
| MEX | Mexico | MX-PP-N | MX-PP-N | Passport | No |
| MHL | Marshall Islands | MH-PP-N | MH-PP-N | Passport | No |
| MKD | North Macedonia | MK-PP-N | MK-PP-N | Passport | No |
| MLI | Mali | ML-PP-N | ML-PP-N | Passport | No |
| MLT | Malta | MT-PP-N | MT-PP-N | Passport | No |
| MMR | Myanmar | MM-PP-N | MM-PP-N | Passport | No |
| MNG | Mongolia | MN-PP-N | MN-PP-N | Passport | No |
| MNP | Northern Mariana Islands | MP-PP-N | MP-PP-N | Passport | No |
| MOZ | Mozambique | MZ-PP-N | MZ-PP-N | Passport | No |
| MRT | Mauritania | MR-PP-N | MR-PP-N | Passport | No |
| MSR | Montserrat | MS-PP-N | MS-PP-N | Passport | No |
| MTQ | Martinique | MQ-PP-N | MQ-PP-N | Passport | No |
| MUS | Mauritius | MU-PP-N | MU-PP-N | Passport | No |
| MWI | Malawi | MW-PP-N | MW-PP-N | Passport | No |
| MYS | Malaysia | MY-ID-N | MY-ID-MYKAD,MY-ID-PR | Malaysia Identity Card or Malaysia Permanent Resident (PR) Card. | Yes |
| MYS | Malaysia | MY-ID-MYKAD | MY-ID-MYKAD | Malaysia Identity Card | Yes |
| MYS | Malaysia | MY-ID-PR | MY-ID-PR | Malaysia Permanent Resident (PR) Card | Yes |
| MYS | Malaysia | MY-PP-N | MY-PP-N | Passport | No |
| MYT | Mayotte | YT-PP-N | YT-PP-N | Passport | No |
| NAM | Namibia | NA-PP-N | NA-PP-N | Passport | No |
| NCL | New Caledonia | NC-PP-N | NC-PP-N | Passport | No |
| NER | Niger | NE-PP-N | NE-PP-N | Passport | No |
| NFK | Norfolk Island | NF-PP-N | NF-PP-N | Passport | No |
| NGA | Nigeria | NG-PP-N | NG-PP-N | Passport | No |
| NIC | Nicaragua | NI-PP-N | NI-PP-N | Passport | No |
| NIU | Niue | NU-PP-N | NU-PP-N | Passport | No |
| NLD | Netherlands | NL-PP-N | NL-PP-N | Passport | No |
| NOR | Norway | NO-PP-N | NO-PP-N | Passport | No |
| NPL | Nepal | NP-PP-N | NP-PP-N | Passport | No |
| NRU | Nauru | NR-PP-N | NR-PP-N | Passport | No |
| NZL | New Zealand | NZ-PP-N | NZ-PP-N | Passport | No |
| OMN | Oman | OM-PP-N | OM-PP-N | Passport | No |
| PAK | Pakistan | PK-PP-N | PK-PP-N | Passport | No |
| PAN | Panama | PA-PP-N | PA-PP-N | Passport | No |
| PCN | Pitcairn | PN-PP-N | PN-PP-N | Passport | No |
| PER | Peru | PE-PP-N | PE-PP-N | Passport | No |
| PHL | Philippines | PH-PP-N | PH-PP-N | Passport | No |
| PLW | Palau | PW-PP-N | PW-PP-N | Passport | No |
| PNG | Papua New Guinea | PG-PP-N | PG-PP-N | Passport | No |
| POL | Poland | PL-PP-N | PL-PP-N | Passport | No |
| PRI | Puerto Rico | PR-PP-N | PR-PP-N | Passport | No |
| PRK | North Korea | KP-PP-N | KP-PP-N | Passport | No |
| PRT | Portugal | PT-PP-N | PT-PP-N | Passport | No |
| PRY | Paraguay | PY-PP-N | PY-PP-N | Passport | No |
| PSE | Palestine | PS-PP-N | PS-PP-N | Passport | No |
| PYF | French Polynesia | PF-PP-N | PF-PP-N | Passport | No |
| QAT | Qatar | QA-PP-N | QA-PP-N | Passport | No |
| REU | Réunion | RE-PP-N | RE-PP-N | Passport | No |
| ROU | Romania | RO-PP-N | RO-PP-N | Passport | No |
| RUS | Russia | RU-PP-N | RU-PP-N | Passport | No |
| RWA | Rwanda | RW-PP-N | RW-PP-N | Passport | No |
| SAU | Saudi Arabia | SA-PP-N | SA-PP-N | Passport | No |
| SDN | Sudan | SD-PP-N | SD-PP-N | Passport | No |
| SEN | Senegal | SN-PP-N | SN-PP-N | Passport | No |
| SGP | Singapore | SG-PP-N | SG-PP-N | Passport | No |
| SGS | South Georgia and the South Sandwich Islands | GS-PP-N | GS-PP-N | Passport | No |
| SHN | Saint Helena | SH-PP-N | SH-PP-N | Passport | No |
| SJM | Svalbard and Jan Mayen | SJ-PP-N | SJ-PP-N | Passport | No |
| SLB | Solomon Islands | SB-PP-N | SB-PP-N | Passport | No |
| SLE | Sierra Leone | SL-PP-N | SL-PP-N | Passport | No |
| SLV | El Salvador | SV-PP-N | SV-PP-N | Passport | No |
| SMR | San Marino | SM-PP-N | SM-PP-N | Passport | No |
| SOM | Somalia | SO-PP-N | SO-PP-N | Passport | No |
| SPM | Saint Pierre and Miquelon | PM-PP-N | PM-PP-N | Passport | No |
| SRB | Serbia | RS-PP-N | RS-PP-N | Passport | No |
| STP | São Tomé and Príncipe | ST-PP-N | ST-PP-N | Passport | No |
| SUR | Suriname | SR-PP-N | SR-PP-N | Passport | No |
| SVK | Slovakia | SK-PP-N | SK-PP-N | Passport | No |
| SVN | Slovenia | SI-PP-N | SI-PP-N | Passport | No |
| SWE | Sweden | SE-PP-N | SE-PP-N | Passport | No |
| SWZ | Eswatini | SZ-PP-N | SZ-PP-N | Passport | No |
| SYC | Seychelles | SC-PP-N | SC-PP-N | Passport | No |
| SYR | Syria | SY-PP-N | SY-PP-N | Passport | No |
| TCA | Turks and Caicos Islands | TC-PP-N | TC-PP-N | Passport | No |
| TCD | Chad | TD-PP-N | TD-PP-N | Passport | No |
| TGO | Togo | TG-PP-N | TG-PP-N | Passport | No |
| THA | Thailand | TH-ID-N | TH-ID-N | Thailand National ID | Yes |
| THA | Thailand | TH-ID-PINK | TH-ID-PINK | Thailand Pink ID | Yes |
| THA | Thailand | TH-PP-N | TH-PP-N | Passport | No |
| THA | Thailand | TH-DL-N | TH-DL-N | Thailand Driver's License | Yes |
| TJK | Tajikistan | TJ-PP-N | TJ-PP-N | Passport | No |
| TKL | Tokelau | TK-PP-N | TK-PP-N | Passport | No |
| TKM | Turkmenistan | TM-PP-N | TM-PP-N | Passport | No |
| TLS | Timor-Leste | TL-PP-N | TL-PP-N | Passport | No |
| TON | Tonga | TO-PP-N | TO-PP-N | Passport | No |
| TTO | Trinidad and Tobago | TT-PP-N | TT-PP-N | Passport | No |
| TUN | Tunisia | TN-PP-N | TN-PP-N | Passport | No |
| TUR | Turkey | TR-PP-N | TR-PP-N | Passport | No |
| TUV | Tuvalu | TV-PP-N | TV-PP-N | Passport | No |
| TWN | Taiwan | TW-PP-N | TW-PP-N | Passport | No |
| TZA | Tanzania | TZ-PP-N | TZ-PP-N | Passport | No |
| UGA | Uganda | UG-PP-N | UG-PP-N | Passport | No |
| UKR | Ukraine | UA-PP-N | UA-PP-N | Passport | No |
| UMI | United States Minor Outlying Islands | UM-PP-N | UM-PP-N | Passport | No |
| URY | Uruguay | UY-PP-N | UY-PP-N | Passport | No |
| USA | United States | US-PP-N | US-PP-N | Passport | No |
| UZB | Uzbekistan | UZ-PP-N | UZ-PP-N | Passport | No |
| VAT | Vatican City | VA-PP-N | VA-PP-N | Passport | No |
| VCT | Saint Vincent and the Grenadines | VC-PP-N | VC-PP-N | Passport | No |
| VEN | Venezuela | VE-PP-N | VE-PP-N | Passport | No |
| VGB | British Virgin Islands | VG-PP-N | VG-PP-N | Passport | No |
| VIR | U.S. Virgin Islands | VI-PP-N | VI-PP-N | Passport | No |
| VNM | Vietnam | VN-ID-N | VN-ID-N | Vietnam National ID | Yes |
| VNM | Vietnam | VN-PP-N | VN-PP-N | Passport | No |
| VNM | Vietnam | VN-DL-N | VN-DL-N | Vietnam Driver's License | Yes |
| VUT | Vanuatu | VU-PP-N | VU-PP-N | Passport | No |
| WLF | Wallis and Futuna | WF-PP-N | WF-PP-N | Passport | No |
| WSM | Samoa | WS-PP-N | WS-PP-N | Passport | No |
| YEM | Yemen | YE-PP-N | YE-PP-N | Passport | No |
| ZAF | South Africa | ZA-PP-N | ZA-PP-N | Passport | No |
| ZMB | Zambia | ZM-PP-N | ZM-PP-N | Passport | No |
| ZWE | Zimbabwe | ZW-PP-N | ZW-PP-N | Passport | No |
Response Description
the response data structure is similar with Get Result API's Response.
| 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 Identity Verification |
| extra | Extra response info (Exception Message) |
Response.code
| Status Code | Message |
|---|---|
| SUCCESS | OK |
| PARAMETER_ERROR | Parameter error, please check you input. |
| Parameter should not be empty | |
| Solution code is wrong | |
| Region is wrong | |
| Invalid image format, image format should be one of jpeg/jpg/png, and request content type should be image/jpeg or image/png | |
| Invalid image size, max image size should be less than 2M, and image dimension should be between 256 * 256 and 4096 * 4096 | |
| The image download has exceeded 3 seconds. Please check the network and operate again. | |
| SIGNATURE_NOT_EXIST | This signatureId is not exist. |
| ERROR | Server error. |
Response.data
| Field | Description |
|---|---|
signatureId |
|
overallResult |
|
idvResult |
|
errorCode |
|
docDetail |
|
feeDetail |
|
countryCodeIso3 |
|
overallResult
overallResult is the result code of the identity verification, the value is same with DocDetail.orcResult.
| Value | Description |
|---|---|
| PASS | the user passed the identity verification check. |
| FAIL | the user failed the identity verification check. |
errorCode
| Response.data.idvResult | Value | Description |
|---|---|---|
PASS | SUCCESS | The user passed the identity 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. | |
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 | |
CARD_LOW_QUALITY_IMAGE | The document images are too poor to do identity 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. |
Response Examples
SUCCESS
{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId":"f302f5d2454a85c2",
"overallResult": "PASS",
"idvResult": "PASS",
"errorCode": "SUCCESS",
"docDetail": {
"ocrResult": "PASS",
"docFrontImage": "https://abc.com/idFrontImage.jpg",
"docBackImage": "https://abc.com/idBackImage.jpg",
"ocrInfo": {
"front": {
"gender": "PEREMPUAN",
"name": "****** ******",
"address": "****** ****** ****** ******",
"idNumber": "************",
"religion": "",
"birthday": "1977/10/28",
"citizen": "MYS"
},
"back": {
"secondaryIdNumber": "************"
}
},
"qualityLabels": {
"front": [],
"back": []
},
"forgeryLabels": [
"photocopy"
],
"eventDetails": [
{
"event": "BE_DOCUMENT",
"result": "PASS",
"createTimestmap": 1665993522952
}
]
},
"feeDetail": [
{
"name": "SOLUTION",
"type": "SOLUTION"
}
],
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226",
"pricingStrategy": "FREE"
}{
"code": "SUCCESS",
"message": "OK",
"data": {
"signatureId":"f302f5d2454a85c2",
"overallResult":"FAIL",
"idvResult":"FAIL",
"errorCode":"NOT_SUPPORTED_CARD",
"faceDetail": {
"faceResult": null,
"faceImageFar": null,
"faceImageNear": null,
"auditImageUrl": null,
"faceLivenessScore": null,
"faceSimilarityScore": null
},
"docDetail": {
"docResult": null,
"docFrontImage": null,
"docBackImage": null,
"ocrInfo": null,
"qualityLabels": null,
"forgeryLabels": null
},
"feeDetail": [
{
"name": "SOLUTION",
"type": "SOLUTION"
}
],
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226",
"pricingStrategy": "FREE"
}{
"code": "SUCCESS",
"message": "OK",
"data": {
"overallResult": null, // still in processing
"idvResult": null, // still in processing
"errorCode": null,
"docDetail": {
"ocrResult": "PASS",
"docFrontImage": "https://abc.com/idFrontImage.jpg",
"docBackImage": "https://abc.com/idBackImage.jpg",
"ocrInfo": {
"front": {
"birthday": "OCTOBER 28,1977",
"name": "**************",
"birthdayParsed": "1977/10/28",
"idNumber": "09-*******-*"
},
"back": null
},
"qualityLabels": {
"front": [],
"back": []
},
"forgeryLabels": null, // in processing
"eventDetails": [
{
"event": "BE_DOCUMENT",
"result": "PASS",
"createTimestmap": 1665993522952
}
]
},
"feeDetail": [
{
"name": "SOLUTION",
"type": "SOLUTION"
}
],
"countryCodeIso3":"MYS"
},
"extra": null,
"transactionId": "d3fde1547eeaf226",
"pricingStrategy": "FREE"
}SIGNATURE_NOT_EXIST
{
"code":"SIGNATURE_NOT_EXIST",
"message":"This signatureId is not exist",
"data":null,
"extra":null,
"transactionId":"b6d722f7e9f553ae",
"pricingStrategy":"FREE"
}Updated 2 months ago
