Documentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
Formato do erro
{
"code": "<error_code>",
"title": "<error_title>",
"message": "<error_message>"
}
code – Um identificador único e estável para o erro. Útil para tratamento programático e solicitações de suporte.title – Um resumo curto e legível do problema.message – Orientação detalhada para ajudá-lo a resolver o erro.
Essa estrutura garante que você sempre receba feedback acionável quando algo não sair como esperado.
Erros do CRM
Os seguintes erros podem ocorrer ao interagir com os endpoints do CRM. Cada erro segue nossa estrutura padrão, facilitando a depuração e a resposta a problemas de forma programática.
Consulte a tabela abaixo para uma lista de possíveis códigos de erro, o que eles significam e como resolvê-los.
400
code | title | message |
|---|
| CRM-0001 | Invalid Metadata Nesting | The metadata object cannot contain nested values. Please ensure that the value %v is not nested and try again. |
| CRM-0002 | Metadata Key Length Exceeded | The metadata key %v exceeds the maximum allowed length of %v characters. 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 | 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 %v and ensure they meet the required format before trying again. |
| 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. The unexpected fields are listed in the fields object. |
| CRM-0009 | Pagination Limit Exceeded | The pagination limit exceeds the maximum allowed of %v 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 %v exceeds the maximum allowed length of %v characters. Please use a shorter value. |
| 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 ‘%v’ and ensure they meet the required format before trying again. |
| CRM-0017 | Unable to Delete Holder | The holder cannot be deleted because it has one or more associated aliases. |
| 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. |
| CRM-0019 | Invalid Metadata Format | The metadata parameter format is invalid. Metadata must be provided in the ‘metadata.field=value’ format. Please check the documentation for correct usage. |
| CRM-0020 | Invalid Metadata Key | The metadata key ‘%s’ contains invalid characters. Metadata keys must use only alphanumeric characters, underscores, and hyphens after the ‘metadata.’ prefix. |
| CRM-0021 | Potentially Unsafe Metadata Value | The metadata value ‘%s’ contains characters that could be used for database injection attacks. Please remove any MongoDB operators (like where,regex) from your query. |
| CRM-0022 | Invalid Header Value | One or more headers have invalid values. Please check the following headers %v and ensure they contain valid UUIDs before trying again. |
| CRM-0023 | Alias Closing Date Before Creation Date | The alias closing date cannot be before the creation date. Please provide a valid closing date. |
| CRM-0025 | Invalid Related Party Role | The provided related party role is not valid. Accepted roles are: PRIMARY_HOLDER, LEGAL_REPRESENTATIVE, or RESPONSIBLE_PARTY. |
| CRM-0026 | Related Party Document Required | The related party document is required. Please provide a valid document. |
| CRM-0027 | Related Party Name Required | The related party name is required. Please provide a valid name. |
| CRM-0028 | Related Party Start Date Required | The related party start date is required. Please provide a valid start date. |
| CRM-0029 | Related Party End Date Invalid | The related party end date must be after the start date. Please provide a valid end date. |
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 | Alias ID Not Found | The provided alias ID does not exist in our records. Please verify the account ID and try again. |
| CRM-0024 | Related Party Not Found | The specified related party does not exist. Please verify the related party ID and try again. |
409
code | title | message |
|---|
| CRM-0010 | Document Association Error | A document can only be associated with one holder. |
| CRM-0013 | Account Already Associated | An accountId from ledger can only be associated with a single related account on CRM. |
500
code | title | message |
|---|
| CRM-0014 | Internal Server Error | The server encountered an unexpected error. Please try again later or contact support. |
