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 or F100.
  • 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 codeError source
E100Business information
E200Stakeholder details
E300Applicant details
E400Risk assessment info
E500Additional info
E600RFI

Invalid field in request

Error codeError source
F100Business information
F200Stakeholder details
F300Applicant details
F400Risk assessment info
F500Additional info
F600RFI

Parameters are invalid

Error codeError source
P100Parameters are missing
Q100Parameters are invalid
Q101Combination of parameters could not be used to find data

Errors from partners

Error codeError source
I400Validation error at one of our partners

Other errors

Error codeError source
R400Bad request (anything that can't be categorized above)
R500Any internal service, vendor, or underlying service is down
R601Status change request from an invalid status
R602Link regeneration failed - while customer applicant KYC is submitted
R603Link regeneration failed - while customer applicant KYC is in ERROR state
R604Link regeneration failed - link regeneration can't be initiated for this compliance status
R605Link regeneration failed - link regeneration can't be initiated for the applicant's current KYC status
R606Functionality not available in the current status
R700Too many requests
S100Any error that isn't classified in the above scenarios

⚠️

CAUTION

In some some cases, the errorDetails field is not available while the old errors field is still operational. When the errorDetails field is not available, use the errors field.