Skip to content

Envia um documento para a captura e extração de dados

Request

Recebe um arquivo (PDF, JPEG, PNG ou BMP; máximo de 10 MB) via multipart/form-data e o encaminha para a extração automática de dados. Retorna o identificador do documento a ser processado, utilizado para consultar o status do processamento posteriormente.

Security
BearerAuth
Bodymultipart/form-datarequired
arquivostring, (binary)required

Arquivo a ser enviado (PDF, JPEG, PNG ou BMP; máximo de 10 MB)

descricaostring

Descrição opcional do documento (máximo de 255 caracteres)

curl -i -X POST \
  https://api-v2.contaazul.com/v1/captura/documentos \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F arquivo=string \
  -F descricao=string

Responses

Documento aceito para captura

Bodyapplication/json
idstring

ID do documento criado; chave para consultar o status

Example:"b9eac698-6eba-4901-b355-2f2748e386e0"
nomestring

Nome do arquivo enviado

Example:"recibo-01-06.pdf"
Response
{ "id": "b9eac698-6eba-4901-b355-2f2748e386e0", "nome": "recibo-01-06.pdf" }