Document submission
After submitting the assignor's registration, the documents related to it must be submitted. This uses the document analysis structure, in which — both on creation and on update — an analysis is generated and the appropriate documents must be submitted. It is up to the manager to verify the operation of the assignor that will operate with the managed funds and, later, at the master contract creation stage, a manager's declaration must be signed attesting that the manager carried out the entire analysis required by the Rules and Procedures for the Administration and Management of Third-Party Assets manual, which assigns to the manager both the analysis and the update of the assignor's registration.
If this is an update, the documents from the last approved analysis are automatically reused and may be replaced by new ones.
Documents are accepted only while the analysis is in pending_documents. Through the manager and the consultant, submission is restricted to the agent that owns the registration (the one who created it); for any other agent, the API responds with ASR000004.
Submitted the wrong document?
Resubmit the correct document with the same document_type while the analysis is still in pending_documents. The previous document of that type (valid or accepted) automatically moves to canceled and the new one replaces it. There is no cancellation call.
The exception is additional_document: additional documents accumulate and are not replaced. If an additional document was submitted by mistake, contact the integration team at integracao.dtvm@qitech.com.br before triggering the analysis.
After the Submission for Analysis, the analysis no longer accepts documents (ASR000039). To correct it, generate a new analysis through the Registration Update.
Assignor Documents
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Register Assignor |
| Assignor | assignor-api | Write |
Base URL for each host: Environments (Hosts).
Request
{
"document_type":"social_contract",
"document_b64": "JVBERi0xLjQK...",
"observation":"CONTRATO SOCIAL ATUALIZADO"
}
Document Object
| Field | Type | Description | Characters |
|---|---|---|---|
document_type * | string | Document type. | See Document Types. |
document_b64 * | string | PDF file, Base64-encoded. | - |
observation | string | Free-form field to describe the files submitted. | 1 - 255 |
*Required fields.
Response
{
"document_key": "8e515a17-8b4d-49a3-aed6-47c9574e426a",
"document_type": "social_contract",
"status": "valid",
"observation": "CONTRATO SOCIAL ATUALIZADO",
"reference_date": null
}
In the case of a registration update, submitting documents specific to the assignor in the analysis is only necessary when there is an update to information that is specific to the assignor.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided (or, for the manager and the consultant, the registration does not belong to your integration). Check whether the assignor_registry_key is correct. |
| 404 | ASR000033 | Analysis not found for the analysis_key provided. Check whether the analysis_key is correct. |
| 400 | ASR000039 | The analysis's current status does not accept new documents. Documents can only be attached while the analysis is in pending_documents. To resubmit after the analysis has started — or if the analysis was canceled due to inactivity (canceled) — generate a new analysis via Registration Update. |
| 400 | ASR000005 | Invalid file format. Send document_b64 as a valid base64 string. |
| 400 | ASR000060 | The file submitted is not a valid PDF. The decoded content of document_b64 must be a PDF. |
| 400 | ASR000059 | File size exceeds the limit. Reduce the PDF size before submitting (the limit is stated in the error message). |
| 400 | ASR000061 | Invalid document type for the assignor. Use a document_type compatible with the assignor's person type (see the Standard assignor/guarantor documents table). |
Authentication, permission and host errors: see API Errors.
Related Party Documents
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | View Assignors |
| Assignor | assignor-api | Write |
Base URL for each host: Environments (Hosts).
Request
{
"document_type":"cnh",
"document_b64": "JVBERi0xLjQK...",
"observation":"CNH Válida"
}
Response
{
"document_key": "afe8532a-4b0b-4e63-8d16-5084b2681752",
"status": "valid",
"document_type": "cnh",
"observation": "CNH Válida"
}
In the case of a registration update, submitting the related parties' documents in the analysis is only necessary when there is an inclusion or update of the assignor's related parties.
If a document is submitted with the wrong type, or with poor quality, it may come back with the accepted status, indicating that its quality is questionable, or even invalid, in which case it must be resubmitted correctly — see Submitted the wrong document?.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided (or, for the manager and the consultant, the registration does not belong to your integration). Check whether the assignor_registry_key is correct. |
| 404 | ASR000033 | Analysis not found for the analysis_key provided. Check whether the analysis_key is correct. |
| 404 | ASR000035 | Analysis related party not found for the analysis_related_party_key provided. Check whether the analysis_related_party_key returned when the analysis was created is correct. |
| 400 | ASR000039 | The analysis's current status does not accept new documents. Documents can only be attached while the analysis is in pending_documents; after that, generate a new analysis via Registration Update. |
| 400 | ASR000005 | Invalid file format. Send document_b64 as a valid base64 string. |
| 400 | ASR000060 | The file submitted is not a valid PDF. The decoded content of document_b64 must be a PDF. |
| 400 | ASR000059 | File size exceeds the limit. Reduce the PDF size before submitting (the limit is stated in the error message). |
| 400 | ASR000062 | Invalid document type for the related party. Use a document_type compatible with the related party's person type (see the Standard related party/representative documents table). |
Authentication, permission and host errors: see API Errors.
Standard assignor/guarantor documents
| Person Type | document_type | Description | Requirement |
|---|---|---|---|
| Natural Person | cnh | CNH (Brazilian driver's license) | * |
| Natural Person | cin_digital | National Identity Card (Digital) | * |
| Natural Person | rg_back | RG (identity card) - Back | * |
| Natural Person | rg_front | RG (identity card) - Front | * |
| Legal Entity | social_contract | Articles of Association | Always |
| Legal Entity | commercial_board_certificate | Simplified Certificate from the Board of Trade | Optional, but mandatory for articles of association dated more than 3 years ago |
| Legal Entity | board_election_record | Board of directors election - if applicable | Required to evidence the relationship |
*For any natural person, only one of the following is required: RG front and back, CNH, or National Identity Card.
Standard related party/representative documents
| Person Type | document_type | Description | Requirement |
|---|---|---|---|
| Natural Person | cnh | CNH (Brazilian driver's license) | * |
| Natural Person | cin_digital | National Identity Card (Digital) | * |
| Natural Person | rg_back | RG (identity card) - Back | * |
| Natural Person | rg_front | RG (identity card) - Front | * |
| Natural Person | power_of_attorney | Power of attorney (natural person or legal entity) - mandatory when the representative is an attorney-in-fact | Required to evidence the relationship |
*For any natural person, only one of the following is required: RG front and back, CNH, or National Identity Card.
Some document types go through an OCR tool for data extraction and verification. Always pay attention to the document submission response, which synchronously returns the OCR validation — valid/accepted/invalid.
Document Types
Document Type
| Enumerator | Description |
|---|---|
| cnh | CNH (Brazilian driver's license). |
| rg_back | RG, back side. |
| rg_front | RG, front side. |
| passport | Passport - for foreigners only. |
| national_migration_registry | National Migration Registry. |
| national_registry_of_foreigners | National Registry of Foreigners. |
| cin_digital | National Identity Card (Digital). |
| social_contract | Articles of Association / Bylaws. |
| cnpj_card | CNPJ card. |
| commercial_board_certificate | Simplified Certificate from the Board of Trade. |
| board_election_record | Minutes of the Election of the Current Board of Directors. |
| power_of_attorney | Power of attorney - mandatory when the representative is an attorney-in-fact. |
| marital_power_of_attorney | Spousal power of attorney - available for spouses only. |
| compliance_statement | Compliance Opinion. |
| financial_statement | Financial Statement. |
| credit_report | Credit Minutes/Opinion. |
| manager_statement | Manager's Opinion/Record. |
| visit_report | Visit Report. |
| proof_of_residence | Proof of Residence. |
| credit_agency_consulation | Credit bureau inquiry. |
| annual_revenues_declaration | Revenue Declaration. |
| financial_institutions_declaration | Banking Relationship Declaration. |
| additional_document | Additional document - free-form. |
Document Status
| Enumerator | Description |
|---|---|
| created | Created |
| valid | Valid |
| invalid | Invalid |
| canceled | Canceled (replaced by a new submission of the same type) |
| accepted | Accepted, but not validated |
| inconclusive | Inconclusive validation |