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.
Cxxx – RFI
Error code
Error source
C101
Reference ID is required to process the responded RFI for Template {0}.
C102
One of the RFI template IDs is blank.
C301
Reference ID is incorrect for the responded RFI for Template {0}.
C302
Invalid RFI template ID(s) {0}.
C401
Provided Information or document is incorrect for the responded RFI for Template {0}.
C402
The RFI has already been responded for template ID {0}.
Exxx – 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
E800
Region
E900
Bank details (HK)
Fxxx – 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
F800
Region
F900
Bank details (HK)
Ixxx – Errors from partners
Error code
Error source
I000
KYC is approved.
I100
Fetching data from the partner is not complete.
I300
The application is being reviewed by our compliance agent.
I400
Validation error at one of our partners
I500
An internal service is down.
I601
The status change request is from an invalid status.
I602
The status change request is from an unauthorized personnel.
I603
The link expired.
Jxxx – Application approval rule errors
Error code
Error Source
J100
The application is being reviewed by our compliance agent.
J200
The application is being reviewed by our compliance agent.
J300
The application is being reviewed by our compliance agent.
J400
The application is being reviewed by our compliance agent.
Pxxx and Qxxx – Parameters are invalid
Error code
Error source
P100
Parameters are missing.
–– Q ––
Q100
Parameters are invalid.
Q101
Combination of parameters could not be used to find data.
Q102
clientHashId cannot be found.
Q103
customerHashId cannot be found.
Rxxx and Zxxx – Other errors
Error code
Error source
R400
Bad request – anything that can't be categorized above.
R401
KYC was already completed.
R403
The document was already uploaded.
R408
The link already expired.
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
That functionality isn't available in the current status.
R607
The customer can't be created in the current status.
R608
The customer can't use functionalities like the Get Application Details API until after the applicant's KYC is submitted.
R609
An invalid request structure was provided in the stakeholders object.
R700
Too many requests.
R800
Resubmission is blocked because the application was rejected due to high risk.
Z100
Any error that isn't classified in the above scenarios.
⚠️
CAUTION
In some cases, the errorDetails field may not be available where the previous version of errors field is in use.
