Skip to main content
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

CodeTitleMessage
CRM-0001Invalid Metadata NestingThe metadata object cannot contain nested values. Please ensure that the value %v is not nested and try again.
CRM-0002Metadata Key Length ExceededThe metadata key %v exceeds the maximum allowed length of %v characters. Please use a shorter key.
CRM-0003Missing Fields in RequestYour request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request.
CRM-0004Invalid Field TypeYour 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-0005Invalid Path ParameterOne or more path parameters are in an incorrect format. Please check the following parameters %v and ensure they meet the required format before trying again.
CRM-0007Unexpected Fields in the RequestThe request body contains more fields than expected. Please send only the allowed fields as per the documentation. The unexpected fields are listed in the fields object.
CRM-0009Pagination Limit ExceededThe pagination limit exceeds the maximum allowed of %v items per page. Please verify the limit and try again.
CRM-0011Invalid Sort OrderThe ‘sort_order’ field must be ‘asc’ or ‘desc’. Please provide a valid sort order and try again.
CRM-0012Metadata Value Length ExceededThe metadata value %v exceeds the maximum allowed length of %v characters. Please use a shorter value.
CRM-0015Bad RequestThe server could not understand the request due to malformed syntax. Please check the listed fields and try again.
CRM-0016Invalid Query ParameterOne or more query parameters are in an incorrect format. Please check the following parameters ‘%v’ and ensure they meet the required format before trying again.
CRM-0017Unable to Delete HolderThe holder cannot be deleted because it has one or more associated aliases.
CRM-0018Missing Headers in RequestYour 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.
CRM-0019Invalid Metadata FormatThe metadata parameter format is invalid. Metadata must be provided in the ‘metadata.field=value’ format. Please check the documentation for correct usage.
CRM-0020Invalid Metadata KeyThe metadata key ‘%s’ contains invalid characters. Metadata keys must use only alphanumeric characters, underscores, and hyphens after the ‘metadata.’ prefix.
CRM-0021Potentially Unsafe Metadata ValueThe metadata value ‘%s’ contains characters that could be used for database injection attacks. Please remove any MongoDB operators (like where,where, regex) from your query.
CRM-0022Invalid Header ValueOne or more headers have invalid values. Please check the following headers %v and ensure they contain valid UUIDs before trying again.

​
404

CodeTitleMessage
CRM-0006Holder ID Not FoundThe provided holder ID does not exist in our records. Please verify the holder ID and try again.
CRM-0008Alias ID Not FoundThe provided alias ID does not exist in our records. Please verify the account ID and try again.

​
409

CodeTitleMessage
CRM-0010Document Association ErrorA document can only be associated with one holder.
CRM-0013Account Already AssociatedAn accountId from ledger can only be associated with a single related account on CRM.

​
500

CodeTitleMessage
CRM-0014Internal Server ErrorThe server encountered an unexpected error. Please try again later or contact support.