Buscar Lotes de Documentos para Assinatura
Introdução
Este recurso retorna os lotes de documentos (document_batches) gerados para um investidor após o envio da análise cadastral. Cada lote agrupa os documentos a serem assinados (ficha cadastral, termos de investidor qualificado/profissional, etc.) e expõe o status e o método de assinatura de cada documento.
Input / Output
Não há corpo de requisição. Opcionalmente é possível filtrar por análise cadastral via query param.
Como output será retornada a lista de lotes do investidor.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Consultoria | consultant-api | Liberada pelo time de integração |
URL base de cada host: Ambientes (Hosts).
Request
/investor_registry/investor/{investor_key}/document_batchesGET200Query params
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
investor_analysis_key | string | Filtra os lotes pertencentes a uma análise cadastral específica | Não |
Response
[
{
"document_batch_key": "UUID",
"status": "pending_signature",
"investor_analysis_key": "UUID",
"url": "https://docs.qitech.com.br/...",
"documents": [
{
"investor_document_key": "UUID",
"document_type": "legal_person_registry_form",
"status": "generated",
"signature_method": "certifiqi"
},
{
"investor_document_key": "UUID",
"document_type": "professional_investor_term",
"status": "generated",
"signature_method": "certifiqi"
}
]
}
]
Document Batch Status
| Enumerador | Descrição |
|---|---|
creating_documents | Documentos sendo gerados |
pending_signer_groups | Aguardando grupos de assinantes |
send_to_signature | Enviados para assinatura |
pending_signature | Aguardando assinatura |
signed | Assinados |
Para detalhes de cada assinatura em um lote específico, utilize GET /investor_registry/investor/{investor_key}/document_batch/{document_batch_key}/signature_details.
Quando o investidor selecionou fundos durante o cadastro (ver Selecionar Fundo), o lote inclui também document_type: "adhesion_term" para cada adesão aprovada e, quando aplicável, nonconformity_term — ver Status da Adesão.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | IVR000008 | Investidor não encontrado |
Erros de autenticação, permissão e host: veja Erros da API.