Envio de documentos
Após o envio do cadastro do cedente, devem ser enviados os documentos relacionados ao mesmo. Para isso, é utilizada a estrutura de análise de documentos, onde, tanto na criação quanto na alteração, uma análise é gerada e os devidos documentos devem ser enviados. Cabe à gestora averiguar a operação do cedente que irá operar com os fundos geridos, e, futuramente, na etapa de criação de contrato mãe, será necessário assinar uma declaração da gestora, atestando que a mesma cumpriu toda a análise requerida pelo manual de Regras e Procedimentos de Administração e Gestão de Recursos de Terceiros, a qual encarrega à gestora tanto a análise quanto a atualização do cadastro do cedente.
Caso se trate de uma atualização, os documentos da última análise aprovada são automaticamente reaproveitados, podendo ser substituídos por novos.
Documentos só são aceitos enquanto a análise estiver em pending_documents. Pela gestora e pela consultoria, o envio é restrito ao agente dono do cadastro (quem o criou); para outro agente, a API responde ASR000004.
Enviou o documento errado?
Reenvie o documento correto com o mesmo document_type, enquanto a análise ainda estiver em pending_documents. O documento anterior daquele tipo (valid ou accepted) passa automaticamente para canceled e o novo o substitui. Não existe chamada de cancelamento.
A exceção é additional_document: documentos adicionais se acumulam e não são substituídos. Se um documento adicional foi enviado por engano, fale com o time de integração em integracao.dtvm@qitech.com.br antes de disparar a análise.
Depois do Envio para Análise, a análise não aceita mais documentos (ASR000039). Para corrigir, gere uma nova análise pela Atualização de Cadastro.
Documentos do Cedente
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Cadastrar Cedente |
| Cedente | assignor-api | Escrita |
URL base de cada host: Ambientes (Hosts).
Request
{
"document_type":"social_contract",
"document_b64": "JVBERi0xLjQK...",
"observation":"CONTRATO SOCIAL ATUALIZADO"
}
Objeto de Documento
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
document_type * | string | Tipo do documento. | Ver Tipos de Documento. |
document_b64 * | string | Arquivo PDF codificado em Base64. | - |
observation | string | Campo livre para descrever arquivos enviados. | 1 - 255 |
*Campos obrigatórios.
Response
{
"document_key": "8e515a17-8b4d-49a3-aed6-47c9574e426a",
"document_type": "social_contract",
"status": "valid",
"observation": "CONTRATO SOCIAL ATUALIZADO",
"reference_date": null
}
Em caso de atualização cadastral, o envio de documentos específicos do cedente na análise será necessário somente quando houver alguma atualização nas informações que sejam específicas do cedente.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado (ou, para gestora e consultoria, o cadastro não pertence à sua integração). Verificar se o assignor_registry_key está correto. |
| 404 | ASR000033 | Análise não encontrada para o analysis_key informado. Verificar se o analysis_key está correto. |
| 400 | ASR000039 | O status atual da análise não aceita novos documentos. Documentos só podem ser anexados quando a análise estiver em pending_documents. Para reenviar após análise iniciada — ou se a análise tiver sido cancelada por inatividade (canceled) — gere uma nova análise via Atualização de Cadastro. |
| 400 | ASR000005 | Formato de arquivo inválido. Enviar document_b64 como string em base64 válida. |
| 400 | ASR000060 | O arquivo enviado não é um PDF válido. O conteúdo decodificado de document_b64 deve ser um PDF. |
| 400 | ASR000059 | Tamanho do arquivo excede o limite. Reduzir o tamanho do PDF antes de enviar (limite informado na mensagem do erro). |
| 400 | ASR000061 | Tipo de documento inválido para o cedente. Usar um document_type compatível com o tipo de pessoa do cedente (ver tabela Documentos padrão do cedente/avalista). |
Erros de autenticação, permissão e host: veja Erros da API.
Documentos das partes relacionadas
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Ler Cedentes |
| Cedente | assignor-api | Escrita |
URL base de cada host: Ambientes (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"
}
Em caso de atualização cadastral, o envio de documentos das partes relacionadas na análise será necessário somente quando houver alguma inclusão ou atualização de partes relacionadas do cedente.
Caso um documento seja enviado com o tipo errado, ou com má qualidade ele pode retornar com o status accepted, indicando que a qualidade do mesmo está duvidosa, ou até invalid, assim sendo necessário reenviá-lo corretamente — veja Enviou o documento errado?.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado (ou, para gestora e consultoria, o cadastro não pertence à sua integração). Verificar se o assignor_registry_key está correto. |
| 404 | ASR000033 | Análise não encontrada para o analysis_key informado. Verificar se o analysis_key está correto. |
| 404 | ASR000035 | Parte relacionada da análise não encontrada para o analysis_related_party_key informado. Verificar se o analysis_related_party_key retornado na criação da análise está correto. |
| 400 | ASR000039 | O status atual da análise não aceita novos documentos. Documentos só podem ser anexados quando a análise estiver em pending_documents; depois disso, gere uma nova análise via Atualização de Cadastro. |
| 400 | ASR000005 | Formato de arquivo inválido. Enviar document_b64 como string em base64 válida. |
| 400 | ASR000060 | O arquivo enviado não é um PDF válido. O conteúdo decodificado de document_b64 deve ser um PDF. |
| 400 | ASR000059 | Tamanho do arquivo excede o limite. Reduzir o tamanho do PDF antes de enviar (limite informado na mensagem do erro). |
| 400 | ASR000062 | Tipo de documento inválido para a parte relacionada. Usar um document_type compatível com o tipo de pessoa da parte relacionada (ver tabela Documentos padrão das partes relacionadas/representantes). |
Erros de autenticação, permissão e host: veja Erros da API.
Documentos padrão do cedente/avalista
| Tipo de Pessoa | document_type | Descrição | Obrigatoriedade |
|---|---|---|---|
| Pessoa Física | cnh | CNH (Carteira Nacional de Habilitação) | * |
| Pessoa Física | cin_digital | Carteira de Identidade Nacional (Digital) | * |
| Pessoa Física | rg_back | RG (Carteira de Identidade) - Verso | * |
| Pessoa Física | rg_front | RG (Carteira de Identidade) - Frente | * |
| Pessoa Jurídica | social_contract | Contrato Social | Sempre |
| Pessoa Jurídica | commercial_board_certificate | Certidão Simplificada da Junta Comercial | Opcional, entretanto obrigatório para contratos sociais com data superior a 3 anos |
| Pessoa Jurídica | board_election_record | Eleição da diretoria - se aplicável | Necessário para comprovação de vínculo |
*Para quaisquer pessoas físicas, é necessário apenas um dentre RG frente e verso, CNH e Carteira de Identidade Nacional.
Documentos padrão das partes relacionadas/representantes
| Tipo de Pessoa | document_type | Descrição | Obrigatoriedade |
|---|---|---|---|
| Pessoa Física | cnh | CNH (Carteira Nacional de Habilitação) | * |
| Pessoa Física | cin_digital | Carteira de Identidade Nacional (Digital) | * |
| Pessoa Física | rg_back | RG (Carteira de Identidade) - Verso | * |
| Pessoa Física | rg_front | RG (Carteira de Identidade) - Frente | * |
| Pessoa Física | power_of_attorney | Procuração PF ou PJ - Obrigatório caso representante seja um procurador | Necessário para comprovação de vínculo |
*Para quaisquer pessoas físicas, é necessário apenas um dentre RG frente e verso, CNH e Carteira de Identidade Nacional.
Alguns tipos de documentos passam por uma ferramenta de OCR para extração e verificação dos dados. Deve-se sempre atentar ao retorno do envio de documento, que retorna de forma síncrona a validação - valid/accepted/invalid do OCR.
Tipos de Documento
Document Type
| Enumerador | Descrição |
|---|---|
| cnh | CNH. |
| rg_back | RG parte traseira. |
| rg_front | RG parte frontal. |
| passport | Passaporte - exclusivo para estrangeiros. |
| national_migration_registry | Registro Nacional de Migração. |
| national_registry_of_foreigners | Registro Nacional de Estrangeiros. |
| cin_digital | Carteira de Identidade Nacional (Digital). |
| social_contract | Contrato/Estatuto Social. |
| cnpj_card | Cartão CNPJ. |
| commercial_board_certificate | Certidão Simplificada da Junta Comercial. |
| board_election_record | Ata de Eleição da Diretoria Vigente. |
| power_of_attorney | Procuração - obrigatório caso o representante seja um procurador. |
| marital_power_of_attorney | Procuração Uxória - disponível apenas para cônjuges. |
| compliance_statement | Parecer de Compliance. |
| financial_statement | Demonstração Financeira. |
| credit_report | Ata/Parecer de Crédito. |
| manager_statement | Parecer/Ficha do Gestor. |
| visit_report | Relatório de Visita. |
| proof_of_residence | Comprovante de Residência. |
| credit_agency_consulation | Consulta aos órgãos de Proteção de Crédito. |
| annual_revenues_declaration | Declaração de Faturamento. |
| financial_institutions_declaration | Declaração de Relacionamento Bancário. |
| additional_document | Documento adicional - livre. |
Document Status
| Enumerador | Descrição |
|---|---|
| created | Criado |
| valid | Válido |
| invalid | Inválido |
| canceled | Cancelado (substituído por um novo envio do mesmo tipo) |
| accepted | Aceito, porém não validado |
| inconclusive | Validação inconclusiva |