Consulta os dados extraídos da captura do documento enviado

Request

Retorna os dados que a IA Captura extraiu do documento e a sugestão de evento financeiro associada. O envio do documento em POST /v1/captura/documentos devolve o id do documento; com ele, a consulta em GET /v1/captura/documentos/status devolve o id_captura; e é esse id_captura que identifica a captura consultada aqui. A prévia do evento financeiro (previa_evento_financeiro) e a sugestão (sugestao_evento_financeiro) são retornadas apenas quando o status da captura é PENDENTE; nos demais estados (PROCESSANDO, ACEITA, REJEITADA, FALHA) a resposta traz somente id, id_documento e status. Recomenda-se, portanto, consultar este endpoint quando o status já indicar que os dados de extração estão disponíveis (PENDENTE).

Security

BearerAuth

Path

idstringrequired

ID da captura a ser consultada

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/captura/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Dados extraídos da captura

Bodyapplication/json

idstring

ID da captura

Example:"3fa85f64-5717-4562-b3fc-2c963f66afa6"

id_documentostring

ID do documento que originou a captura

Example:"3fa85f64-5717-4562-b3fc-2c963f66afa6"

previa_evento_financeiroobject(PreviaEventoFinanceiro)

Prévia do evento financeiro extraído

statusstring(StatusCaptura)

Status da captura

Enum:"PROCESSANDO""PENDENTE""ACEITA""REJEITADA""FALHA"

Example:"PROCESSANDO"

sugestao_evento_financeiroobject(SugestaoEventoFinanceiro)

Sugestão de evento financeiro gerada pela IA Captura

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id_documento": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "previa_evento_financeiro": {
    "categoria": { … },
    "centro_custo": { … },
    "data_competencia": "2024-10-28",
    "descricao": "Recibo de despesa",
    "fornecedor": { … },
    "observacao": "Parcelado em 10x",
    "parcelas": [ … ],
    "referencia_externa": "external-ref-123",
    "tipo": "DESPESA",
    "valor": 6.75
  },
  "status": "PROCESSANDO",
  "sugestao_evento_financeiro": {
    "id_parcela": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}