Fetch Document Batches for Signature
Introduction
This resource returns the document batches (document_batches) generated for an investor after the registration analysis is sent. Each batch groups the documents to be signed (registration form, qualified/professional investor terms, etc.) and exposes the status and signature method of each document.
Input / Output
There is no request body. Optionally, you can filter by registration analysis via query param.
As output, the list of the investor's batches is returned.
Request
/investor_registry/investor/{investor_key}/document_batchesGET200Query params
| Field | Type | Description | Required |
|---|---|---|---|
investor_analysis_key | string | Filters the batches belonging to a specific registration analysis | No |
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
| Enumerator | Description |
|---|---|
creating_documents | Documents being generated |
pending_signer_groups | Waiting for signer groups |
send_to_signature | Sent for signature |
pending_signature | Waiting for signature |
signed | Signed |
For details of each signature in a specific batch, use GET /investor_registry/investor/{investor_key}/document_batch/{document_batch_key}/signature_details.
When the investor selected funds during registration (see Select Fund), the batch also includes document_type: "adhesion_term" for each approved adhesion and, when applicable, nonconformity_term — see Adhesion Status.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | IVR000008 | Investor not found |
Authentication, permission and host errors: see API Errors.