Erros
Uma requisição que falha não custa nada. A resposta traz um errorCode, um código que o seu sistema pode tratar, e uma mensagem que diz o que fazer: em inglês ou, com o header Accept-Language: pt-BR, em português.
Corrija a requisição
Enviar de novo igual não adianta: faça o que a mensagem diz e envie uma nova requisição.
IMAGE_MISSING
Status: 422
Em português: Nenhuma imagem foi enviada. Envie a imagem da certidão em imageUrl ou imageBase64.
Em inglês: No image was sent. Send the certificate image in imageUrl or imageBase64.
IMAGE_BASE64_INVALID
Status: 422
Em português: O conteúdo de imageBase64 não é um base64 válido. Envie a imagem codificada em base64, por exemplo data:image/jpeg;base64,/9j/4AAQ...
Em inglês: The content of imageBase64 is not valid base64. Send the image encoded in base64, for example data:image/jpeg;base64,/9j/4AAQ...
IMAGE_TOO_LARGE
Status: 413 ou 422
Em português: A imagem tem mais de 10 MB. Envie uma imagem menor, por exemplo um JPG com menos resolução ou qualidade.
Em inglês: The image is larger than 10 MB. Send a smaller image, for example a JPG with lower resolution or quality.
IMAGE_TOO_MANY_PIXELS
Status: 422
Em português: A imagem tem mais de 120 megapixels. Reduza a resolução e envie de novo.
Em inglês: The image has more than 120 megapixels. Reduce its resolution and send it again.
IMAGE_FORMAT_UNSUPPORTED
Status: 422
Em português: O arquivo não está em um destes formatos: PDF, JPG, PNG, WebP ou GIF. Converta para um deles e envie de novo.
Em inglês: The file is not in one of these formats: PDF, JPG, PNG, WebP or GIF. Convert it to one of them and send it again.
IMAGE_UNREADABLE
Status: 422
Em português: Não foi possível ler a imagem: o arquivo parece corrompido ou incompleto. Fotografe ou exporte a certidão de novo e envie o novo arquivo.
Em inglês: The image could not be read: the file seems damaged or incomplete. Photograph or export the certificate again and send the new file.
IMAGE_URL_NOT_ALLOWED
Status: 422
Em português: O imageUrl não pode ser usado: ele aponta para um endereço privado ou local. Use um link público para a imagem ou envie-a em imageBase64.
Em inglês: The imageUrl cannot be used: it points to a private or local address. Use a public link to the image, or send it in imageBase64.
IMAGE_RESOLUTION_TOO_LOW
Status: 422
Em português: A imagem é menor que o nosso padrão de 1.344 a 2.048 px no lado maior. Envie uma foto com mais resolução ou use resizeImage: true para ampliá-la (1 crédito a mais).
Em inglês: The image is smaller than our standard of 1,344 to 2,048 px on the long side. Send a photo with more resolution, or set resizeImage: true to have it enlarged (1 extra credit).
IMAGE_RESOLUTION_TOO_HIGH
Status: 422
Em português: A imagem é maior que o nosso padrão de 1.344 a 2.048 px no lado maior. Reduza-a para no máximo 2.048 px no lado maior ou use resizeImage: true para reduzi-la (1 crédito a mais).
Em inglês: The image is larger than our standard of 1,344 to 2,048 px on the long side. Reduce it to at most 2,048 px on the long side, or set resizeImage: true to have it reduced (1 extra credit).
IMAGE_INVALID
Status: 422
Em português: A imagem não pôde ser usada. Envie um arquivo PDF, JPG, PNG, WebP ou GIF de até 10 MB.
Em inglês: The image could not be used. Send a PDF, JPG, PNG, WebP or GIF file of up to 10 MB.
PDF_PASSWORD_PROTECTED
Status: 422
Em português: O PDF está protegido por senha. Envie o arquivo sem senha.
Em inglês: The PDF is password-protected. Send the file without a password.
PDF_UNREADABLE
Status: 422
Em português: Não foi possível ler o PDF: o arquivo parece corrompido. Exporte-o de novo ou envie a primeira página da certidão como imagem JPG, PNG, WebP ou GIF.
Em inglês: The PDF could not be read: the file seems damaged. Export it again, or send the certificate's first page as a JPG, PNG, WebP or GIF image.
PDF_TOO_MANY_PAGES
Status: 422
Em português: O PDF tem mais de 20 páginas. Envie só a certidão: lemos a primeira página.
Em inglês: The PDF has more than 20 pages. Send only the certificate: we read its first page.
IMAGE_DOWNLOAD_FAILED
Status: 422
Em português: Não conseguimos baixar a imagem de imageUrl: o download falhou. Use um link público e direto para um arquivo PDF, JPG, PNG, WebP ou GIF que abra sem login, ou envie a imagem em imageBase64.
Em inglês: We could not download the image from imageUrl: the download failed. Use a public, direct link to a PDF, JPG, PNG, WebP or GIF file that opens without a login, or send the image as imageBase64.
IMAGE_NOT_PROCESSABLE
Status: 201 com success: false
Em português: A imagem passou pelas nossas verificações, mas não pôde ser processada. Envie uma foto mais nítida da certidão inteira, em JPG ou PNG. Nenhum crédito foi cobrado.
Em inglês: The image passed our checks but could not be processed. Send a sharper photo of the whole certificate, as a JPG or PNG. No credit was charged.
DOCUMENT_NOT_RECOGNIZED
Status: 201 com success: false
Em português: Não foi possível processar o documento. Verifique se a imagem mostra uma certidão de nascimento. Nenhum crédito foi cobrado.
Em inglês: The document could not be processed. Check that the image shows a birth certificate. No credit was charged.
Envie de novo mais tarde
Nenhum motor conseguiu responder agora. A mesma requisição, com o mesmo requestId, pode passar mais tarde.
EXTRACTION_TIMEOUT
Status: 201 com success: false
Em português: A extração demorou demais. Tente novamente; uma imagem mais nítida ou menor ajuda. Nenhum crédito foi cobrado.
Em inglês: The extraction took too long. Please retry; a sharper or smaller image helps. No credit was charged.
EXTRACTION_BUSY
Status: 201 com success: false
Em português: O serviço de extração está ocupado. Tente novamente em alguns instantes. Nenhum crédito foi cobrado.
Em inglês: The extraction service is busy. Please retry in a few moments. No credit was charged.
EXTRACTION_UNAVAILABLE
Status: 201 com success: false
Em português: O serviço de extração está temporariamente indisponível. Tente novamente em alguns instantes. Nenhum crédito foi cobrado.
Em inglês: The extraction service is temporarily unavailable. Please retry in a few moments. No credit was charged.
Aguarde e envie de novo
A mesma requisição ainda está rodando. Aguarde os segundos do header Retry-After e envie de novo: você recebe a resposta dela, sem custo.
REQUEST_IN_PROGRESS
Status: 409
Em português: Uma requisição com este requestId e o mesmo conteúdo ainda está em processamento. Tente de novo em alguns segundos para receber a resposta, sem custo.
Em inglês: A request with this requestId and the same content is still being processed. Try again in a few seconds to get its answer, at no charge.
Adicione créditos
O saldo não paga a requisição, e nada rodou. Compre créditos ou mude de plano no painel.
NOT_ENOUGH_CREDITS
Status: 402
Em português: Esta requisição custa 1 crédito, e o saldo disponível é de 0 crédito. Compre créditos ou faça upgrade do plano para continuar.
Em inglês: This request costs 1 credit, and the available balance is 0 credits. Buy credits or upgrade your plan to continue.
Respostas sem errorCode
Estas respostas da extração não trazem errorCode; a referência mostra cada uma com o seu exemplo.
400
O corpo não é válido: message lista o que corrigir. Nada foi cobrado.
401
A chave de API está ausente, malformada, é desconhecida, foi revogada ou expirou.
429
Acima de um dos limites do seu plano. retryAfter diz quantos segundos aguardar; não há header Retry-After. Um limite por dia volta à meia-noite UTC.
503
O serviço está reiniciando: o proxy responde com uma página HTML, e pode responder 502 ou 504 da mesma forma. Envie a mesma requisição de novo depois de alguns segundos, com o mesmo requestId, para nunca pagar duas vezes.