CRM returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.
Error Format
{
"code": "<error_code>",
"title": "<error_title>",
"message": "<error_message>"
}
Field Definitions
code
– A stable, unique identifier for the error. Useful for programmatic handling and support requests.title
– A short, human-readable summary of the issue.message
– Detailed guidance to help you resolve the error.
This structure ensures you always get actionable feedback when something doesn’t go as expected.
CRM Errors
The following errors can occur when interacting with the CRM endpoints. Each error follows our standard structure, making it easier to debug and respond to issues programmatically.
Refer to the table below for a list of possible error codes, what they mean, and how to resolve them.
400
Code | Title | Message |
---|---|---|
CRM-0001 | Invalid Metadata Nesting | The metadata object cannot contain nested values. Please ensure that the value is not nested and try again. |
CRM-0002 | Metadata Key Length Exceeded | The metadata key exceeds the maximum allowed length. Please use a shorter key. |
CRM-0003 | Missing Fields in Request | Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request. |
CRM-0004 | Invalid Field Type in Request | Your request contains one or more fields with an invalid data type. Please refer to the documentation to verify that all fields have the correct type. |
CRM-0005 | Invalid Path Parameter | One or more path parameters are in an incorrect format. Please check the following parameters and ensure they meet the required format. |
CRM-0007 | Unexpected Fields in the Request | The request body contains more fields than expected. Please send only the allowed fields as per the documentation. |
CRM-0009 | Pagination Limit Exceeded | The pagination limit exceeds the maximum allowed of items per page. Please verify the limit and try again. |
CRM-0011 | Invalid Sort Order | The 'sort_order' field must be 'asc' or 'desc'. Please provide a valid sort order and try again. |
CRM-0012 | Metadata Value Length Exceeded | The metadata value exceeds the maximum allowed length. Please use a shorter value. |
CRM-0013 | Account Already Associated | An accountId from ledger can only be associated with a single related account on CRM. |
CRM-0015 | Bad Request | The server could not understand the request due to malformed syntax. Please check the listed fields and try again. |
CRM-0016 | Invalid Query Parameter | One or more query parameters are in an incorrect format. Please check the following parameters and ensure they meet the required format. |
CRM-0017 | Unable to Delete Holder | The holder cannot be deleted because it has one or more associated accounts. |
CRM-0018 | Missing Headers in Request | Your request is missing one or more required header params. Please refer to the documentation to ensure all necessary header params are included in your request. |
404
Code | Title | Message |
---|---|---|
CRM-0006 | Holder ID Not Found | The provided holder ID does not exist in our records. Please verify the holder ID and try again. |
CRM-0008 | Account ID Not Found | The provided account ID does not exist in our records. Please verify the account ID and try again. |
409
Code | Title | Message |
---|---|---|
CRM-0010 | Document Association Error | A document can only be associated with one holder. |
500
Code | Title | Message |
---|---|---|
CRM-0014 | Internal Server Error | The server encountered an unexpected error. Please try again later or contact support. |