Skip to main content

​
Autenticação

Todas as rotas da API exigem o header x-api-key com a chave do seu projeto.
Para gerar e gerenciar suas chaves, consulte Autenticação API. Quando a chave está ausente ou não é aceita, a resposta é 401 com error igual a UNAUTHORIZED:

​
Formato do erro

As respostas de erro seguem um envelope padrão:
​
string
Código do erro. É um valor estável e enumerável — use-o para tratar o erro na sua integração.
​
string
Descrição legível do erro, muitas vezes montada com detalhes do caso (nome do campo, tipo de arquivo, tamanho).
Use o message apenas para diagnóstico e logs. Não baseie lógica na leitura do texto, pois ele pode mudar. Para ramificar o comportamento, use sempre o campo error.
​
string
Identificador da requisição, útil para correlacionar logs e acionar o suporte.
​
datetime
Data e hora em que o erro foi gerado.

​
Códigos de erro

​
FLEXIMAGE_IMPORT_FAILED: 400 e 502

O mesmo código aparece em duas situações com tratamentos opostos:
O problema está no que foi enviado. Corrija o payload antes de tentar de novo. Causas comuns:
  • O arquivo não está em data URI (data:image/jpeg;base64,...)
  • Tipo não permitido para o campo (selfie não aceita PDF)
  • Conteúdo base64 vazio ou inválido
  • Conteúdo do arquivo não corresponde ao tipo declarado
  • Arquivo acima de 10 MB
O envio falhou na comunicação com o serviço de processamento. Não é um erro do payload. Tente novamente com backoff e, se persistir, acione o suporte com o requestId.