Onboarding error codes
You can use the errorDetails
object in all of the APIs related to Onboarding. In this object, code
can be used to classify messages and to handle different error codes.
Example:
- You can direct an applicant to the business details page when receiving error
E100
orF100
. - You can change the error message and appropriately guide your customer when receiving error
R601
.
The error codes on this page are composed of a letter and a 3-digit number.
Missing field in request
Error code | Error source |
---|---|
E100 | Business information |
E200 | Stakeholder details |
E300 | Applicant details |
E400 | Risk assessment info |
E500 | Additional info |
E600 | RFI |
Invalid field in request
Error code | Error source |
---|---|
F100 | Business information |
F200 | Stakeholder details |
F300 | Applicant details |
F400 | Risk assessment info |
F500 | Additional info |
F600 | RFI |
Parameters are invalid
Error code | Error source |
---|---|
P100 | Parameters are missing |
Q100 | Parameters are invalid |
Q101 | Combination of parameters could not be used to find data |
Errors from partners
Error code | Error source |
---|---|
I400 | Validation error at one of our partners |
Other errors
Error code | Error source |
---|---|
R400 | Bad request (anything that can't be categorized above) |
R500 | Any internal service, vendor, or underlying service is down |
R601 | Status change request from an invalid status |
R602 | Link regeneration failed - while customer applicant KYC is submitted |
R603 | Link regeneration failed - while customer applicant KYC is in ERROR state |
R604 | Link regeneration failed - link regeneration can't be initiated for this compliance status |
R605 | Link regeneration failed - link regeneration can't be initiated for the applicant's current KYC status |
R606 | Functionality not available in the current status |
R700 | Too many requests |
S100 | Any error that isn't classified in the above scenarios |
CAUTION
In some some cases, the
errorDetails
field is not available while the olderrors
field is still operational. When theerrorDetails
field is not available, use theerrors
field.
Updated 9 days ago