Erros e limites

Todo erro diz se vale tentar de novo. É essa informação que muda o que o seu código deve fazer.

A forma de um erro

{
  "schema_version": "1.0",
  "status": "rejected",
  "error": {
    "code": "insufficient_credit",
    "message": "Saldo insuficiente para esta leitura. Compre crédito e reenvie o mesmo arquivo.",
    "available_balance": "0.0000",
    "price_per_reading": "1.0000",
    "retryable": true
  }
}

retryable: true significa que o mesmo arquivo, reenviado depois, passa. O problema não está nele. false significa que repetir não adianta.

Na consulta de tabela, o 402 traz price_per_code e codes_to_bill no lugar de price_per_reading: o preço de um código e quantos códigos a consulta cobraria.

Recusa no envio

HTTP	code	O que fazer
402	`insufficient_credit`	Comprar crédito e reenviar o mesmo arquivo
422	`unsupported_file_type`	Enviar PDF, JPEG ou PNG
422	`file_too_large`	Arquivo acima de 5 MB
422	`too_many_pages`	Mais de 5 páginas. Mande só o BL, sem os anexos
422	`corrupt_file`	Arquivo vazio, truncado ou pequeno demais para ser um documento (menos de 2 KB)

Falha depois de aceito

A requisição foi aceita e a leitura falhou. O status vem failed e o motivo em error_code.

error_code	O que aconteceu
`not_a_bill_of_lading`	O arquivo não é um BL. Uma invoice ou um packing list caem aqui
`multiple_bls_detected`	Mais de um BL no mesmo arquivo. Separe e mande um por vez
`unreadable`	Digitalização ilegível. Vale reenviar com melhor qualidade
`extraction_unavailable`	Falha do nosso lado, não do documento. Pode reenviar

O que cobra

Situação	Cobrança
Leitura nova	Preço integral
Releitura de documento já enviado antes	Metade
Leitura que falha	Nada
Envio recusado (402 ou 422)	Nada
Reenvio de webhook	Nada
Consulta de tabela pela API	Por código consultado
Consulta de tabela na tela do portal	Nada
Consulta recusada por saldo (402)	Nada

A releitura é reconhecida pelo conteúdo do arquivo. Mandar o mesmo PDF duas vezes custa uma leitura e meia, e o resultado é o mesmo, porque é o mesmo documento.

Limites

Limite	Valor
Tamanho do arquivo	5 MB
Páginas	5
Formatos	PDF, JPEG, PNG
Tempo de leitura	cerca de 2 minutos
Janela do Idempotency-Key	24 horas
Itens por página nas listagens	até 200

Autenticação

HTTP	Quando
401	Chave ausente, inválida ou revogada
403	Chave válida numa rota que só existe no portal
404	Recurso de outra conta

Um 404 num job_id que você sabe que existe quase sempre significa chave de outra conta.