Consulta o status de documentos e das extrações (Captura)

Request

Consulta, para um ou mais documentos enviados à IA Captura, o status do processamento do documento e o status da captura (extração) gerada a partir dele. Um documento pode ser processado sem gerar captura — nesse caso, os campos da captura retornam vazios. Como o processamento é assíncrono, a orientação é consultar periodicamente (polling) até que os status cheguem a um estado final.

Security

BearerAuth

Query

idsArray of stringsrequired

IDs dos documentos a serem consultados (máximo 20)

paginainteger

Número da página (padrão 1)

tamanho_paginainteger

Tamanho da página (padrão 10, máximo 20)

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/captura/documentos/status?ids=string&pagina=0&tamanho_pagina=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

itensArray of objects(DocumentStatusItem)

Lista de documentos consultados

paginacaoobject(Pagination)

Dados de paginação

Response

{
  "itens": [
    { … }
  ],
  "paginacao": {
    "pagina_atual": 1,
    "tamanho_pagina": 20,
    "total_itens": 1,
    "total_paginas": 1
  }
}