Consulta de status em lote

O botão Consultar status dos documentos, na tela Documentos, consulta o provedor sobre todos os documentos da empresa que estão em Aguardando assinatura, Aberto ou Assinatura parcial. A consulta roda em segundo plano. Em empresas com muitos documentos, pode levar alguns minutos.

Fluxo

1. Inicie a consulta com PATCH /digital-signature/documents/check-status/bulk. A resposta traz um token.
2. Consulte o andamento com GET /digital-signature/documents/check-status/bulk/status/{token} a cada poucos segundos, até o status virar ready ou failed.

Endpoints

Método	Caminho	Descrição
PATCH	/digital-signature/documents/check-status/bulk	Inicia a consulta em lote
GET	/digital-signature/documents/check-status/bulk/status/{token}	Consulta o andamento da consulta em lote

PATCH /digital-signature/documents/check-status/bulk

Inicia a consulta em segundo plano para os documentos da empresa em Aguardando assinatura, Aberto ou Assinatura parcial. Não há corpo.

Resposta (202):

{ "token": "3f1c0b6e-8a2d-4c57-9b1e-2d7a5f0e6a11" }

Se a fila de processamento não estiver rodando, a consulta fica com status pending até ser processada.

GET /digital-signature/documents/check-status/bulk/status/{token}

Devolve o andamento da consulta iniciada com o token informado.

Resposta (200):

Campo	Descrição
status	pending (na fila), running (em andamento), ready (concluída) ou failed (falhou)
message	Texto de andamento, na língua da requisição
total	Quantidade de documentos a consultar
checked	Quantidade já consultada
changed	Quantidade de documentos cujo status mudou
unchanged	Quantidade de documentos cujo status continuou igual
error	Mensagem de erro, quando status for failed. Caso contrário, null

Erros

Um token inexistente, expirado ou de outro usuário devolve 404 com o corpo {"status": "failed", "error": "not_found"}.

curl https://api.pedagogo.app/digital-signature/documents/check-status/bulk/status/<token> \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"