Onboarding KYB Errors
The following error codes and messages appear in REST responses when an error prevents completion of the request.
Error Code | Description |
---|---|
ERROR_APPLICATION_ACTION | The request tried to save or submit an application, but the action required could not be determined. The request was rejected. Corrective action: Set the second path parameter to 'save' or 'submit'. |
ERROR_APPLICATION_ALREADY_SUBMITTED | The request tried to save or submit an application, but the application has already been submitted. The request was rejected. Corrective action: None. Contact Client Support. |
ERROR_APPLICATION_NOT_FOUND | The request attempted an operation on an application, but the application was not found. The request was rejected. Corrective action: Use the ID of a valid application. |
ERROR_APPLICATION_NOT_VALID | The application cannot be submitted since at least one of its required fields does not have a valid value. Before attempting to resubmit, run the ‘Retrieve Application’ method to view the errors in the relevant fields, and then run the ‘Update Application’ method with the corrected field values. |
ERROR_APPLICATION_TYPE_NOT_FOUND | The request attempted an operation on an application, but the application was not found. The request was rejected. Corrective action: Use the ID of a valid application. |
ERROR_INVALID_SECTION_FOR_UPLOADED_DOCUMENT | The request attempted to upload a document, but the specified section for the document file was invalid. The request was rejected. Corrective action: Rerun the request with a valid section. |
ERROR_MERCHANT_ACCOUNT_ID_NOT_PROVIDED | The request did not include a ‘merchant_account_id’. The request was rejected. Corrective action: Rerun the request with a valid ‘merchant_account_id’. |
ERROR_UPDATE_ONBOARDING_APPLICATION_MCC_NOT_SUPPORTED | The MCC in the request is not supported. The request was rejected. Corrective action: The application must be filled out via its hosted page. The link to the application's hosted page appears at the end of the response code. |
INVALID_FIELDS - [<Name of Field>] | The request attempted an operation, but one or more of the fields did not have a valid value. The request was rejected. Corrective action: Use valid values. The names of the affected fields appear at the end of the error code. See the API Reference for details. |
ERROR_INVALID_SECTION_OR_FIELD_FOR_UPLOADED_DOCUMENT | The request attempted to upload a document, but the specified section and/or field for the document file was invalid. The request was rejected. Corrective action: Rerun the request with a valid field and section. When there are issues for all uploaded files: Error for each file in this request: The request attempted to upload a document, but the specified section and/or field for the document file was invalid. The request was rejected. Corrective action: Rerun the request with a valid field and section |