Pular para o conteúdo principal
Formato do erro
{
   "code": "<error_code>",
   "title": "<error_title>",
   "message": "<error_message>"
}
Definição dos campos
  • 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

CódigoTítuloMensagemTradução
CRM-0001Invalid Metadata NestingThe metadata object cannot contain nested values. Please ensure that the value %v is not nested and try again.O objeto de metadados não pode conter valores aninhados. Por favor, certifique-se de que o valor %v não esteja aninhado e tente novamente.
CRM-0002Metadata Key Length ExceededThe metadata key %v exceeds the maximum allowed length of %v characters. Please use a shorter key.A chave de metadados %v excede o comprimento máximo permitido de %v caracteres. Por favor, use uma chave mais curta.
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.Sua requisição está faltando um ou mais campos obrigatórios. Por favor, consulte a documentação para garantir que todos os campos necessários estejam incluídos na sua requisição.
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.Sua requisição contém um ou mais campos com um tipo de dado inválido. Por favor, consulte a documentação para verificar se todos os campos possuem o tipo correto.
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.Um ou mais parâmetros de caminho estão em um formato incorreto. Por favor, verifique os seguintes parâmetros %v e certifique-se de que atendem ao formato exigido antes de tentar novamente.
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.O corpo da requisição contém mais campos do que o esperado. Por favor, envie apenas os campos permitidos conforme a documentação. Os campos inesperados estão listados no objeto de campos.
CRM-0009Pagination Limit ExceededThe pagination limit exceeds the maximum allowed of %v items per page. Please verify the limit and try again.O limite de paginação excede o máximo permitido de %v itens por página. Por favor, verifique o limite e tente novamente.
CRM-0011Invalid Sort OrderThe ‘sort_order’ field must be ‘asc’ or ‘desc’. Please provide a valid sort order and try again.O campo ‘sort_order’ deve ser ‘asc’ ou ‘desc’. Por favor, forneça uma ordem de classificação válida e tente novamente.
CRM-0012Metadata Value Length ExceededThe metadata value %v exceeds the maximum allowed length of %v characters. Please use a shorter value.O valor de metadados %v excede o comprimento máximo permitido de %v caracteres. Por favor, use um valor mais curto.
CRM-0015Bad RequestThe server could not understand the request due to malformed syntax. Please check the listed fields and try again.O servidor não conseguiu entender a requisição devido a uma sintaxe malformada. Por favor, verifique os campos listados e tente novamente.
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.Um ou mais parâmetros de consulta estão em um formato incorreto. Por favor, verifique os seguintes parâmetros ‘%v’ e certifique-se de que atendem ao formato exigido antes de tentar novamente.
CRM-0017Unable to Delete HolderThe holder cannot be deleted because it has one or more associated aliases.O titular não pode ser excluído porque possui um ou mais aliases associados.
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.Sua requisição está faltando um ou mais parâmetros de cabeçalho obrigatórios. Por favor, consulte a documentação para garantir que todos os parâmetros de cabeçalho necessários estejam incluídos na sua requisição.
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.O formato do parâmetro de metadados é inválido. Os metadados devem ser fornecidos no formato ‘metadata.field=value’. Por favor, consulte a documentação para o uso correto.
CRM-0020Invalid Metadata KeyThe metadata key ‘%s’ contains invalid characters. Metadata keys must use only alphanumeric characters, underscores, and hyphens after the ‘metadata.’ prefix.A chave de metadados ‘%s’ contém caracteres inválidos. As chaves de metadados devem usar apenas caracteres alfanuméricos, underscores e hifens após o prefixo ‘metadata.’.
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.O valor de metadados ‘%s’ contém caracteres que podem ser usados para ataques de injeção de banco de dados. Por favor, remova quaisquer operadores do MongoDB (como where,where, regex) da sua consulta.
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.Um ou mais cabeçalhos possuem valores inválidos. Por favor, verifique os seguintes cabeçalhos %v e certifique-se de que contenham UUIDs válidos antes de tentar novamente.

404

CódigoTítuloMensagemTradução
CRM-0006Holder ID Not FoundThe provided holder ID does not exist in our records. Please verify the holder ID and try again.O ID do titular fornecido não existe em nossos registros. Por favor, verifique o ID do titular e tente novamente.
CRM-0008Alias ID Not FoundThe provided alias ID does not exist in our records. Please verify the account ID and try again.O ID do alias fornecido não existe em nossos registros. Por favor, verifique o ID da conta e tente novamente.

409

CódigoTítuloMensagemTradução
CRM-0010Document Association ErrorA document can only be associated with one holder.Um documento só pode ser associado a um único titular.
CRM-0013Account Already AssociatedAn accountId from ledger can only be associated with a single related account on CRM.Um accountId do ledger só pode ser associado a uma única conta relacionada no CRM.

500

CódigoTítuloMensagemTradução
CRM-0014Internal Server ErrorThe server encountered an unexpected error. Please try again later or contact support.O servidor encontrou um erro inesperado. Por favor, tente novamente mais tarde ou entre em contato com o suporte.