Below is a structure of Unsuccessful Response
Explanation of Error Field Field
{
"event_id": ""XXXX-XXXXX-XXXX-XXXX"",
"errors": [
{
"error_code": 100299,
"message": "mother_maiden_name cannot be empty",
}
]
}
error_code - Customized error code for mapping
message - Description of the error that is happening
Where error_code will consists of this format
- The first 2 digits, will point on the specific API scope where this error comes from
- The 3rd and 4th digits, will point on the error type
- The 5th and 6th digits, will point on the specific error
For the First 2 digits, the example will be as follow:
API Service | Code |
---|---|
Generate Public Access Token | 10 |
Identity + Selfie Verification | 11 |
BOIVA ID Verification | 12 |
For the 3rd and 4th digits, the example will be as follow:
Error Type | Code |
---|---|
User Generated Error | 01 |
Server Generated Error | 02 |
For the 5th and 6th digits, the example will be as follow:
API Scope | Specific Error | Code |
---|---|---|
All API | General Error | 99 |
All API | Missing Header | 98 |
All API | Invalid Header | 97 |
All API | Inactive Client | 96 |
All API | Missing Query Parameter | 95 |
All API | Out of Scope | 94 |
All API | Expired Token | 93 |
All API | Invalid Token | 92 |
All API | Invalid API Key | 91 |
All API | No Sandbox Quota | 90 |
All API | Inactive API | 89 |
Identity Verification | Bad Request in Request Body | 01 |
Identity Verification | Invalid Format in Specific Field Inside Request Body | 02 |
Verify BOIVA Pass | BOIVA Pass Not Found | 51 |
Verify BOIVA Pass | BOIVA Pass Not Active | 52 |
Verify BOIVA Pass | Expired OTP | 53 |
Verify BOIVA Pass | Invalid OTP | 54 |