Pular para o conteúdo principal

Enviar Documento do Investidor


Introdução

Este recurso faz o upload de um documento que compõe a análise cadastral do investidor. Os documentos obrigatórios variam conforme o person_type e o investor_sub_type do investidor, bem como sua categoria (varejo, qualificado, profissional).

Atenção
  • Este endpoint deve ser chamado uma vez para cada documento obrigatório
  • A análise cadastral precisa estar no status pending_registry_data. Em outro status, a chamada é recusada com IVR000026
  • Um mesmo type só aceita um envio bem-sucedido: veja Reenvio e documento duplicado

Input / Output

Como input envie o conteúdo do arquivo em base64, o tipo do documento e a extensão.

Como output será retornada a representação do documento criado, identificado por investor_analysis_document_key, acompanhada da representação completa da análise cadastral à qual ele pertence.

Request

ENDPOINT
/investor_registry/v2/investor/{investor_key}/investor_analysis/{investor_analysis_key}/document
MÉTODO
POST
STATUS
201

Query params

CampoTipoDescriçãoObrigatório
forcebooleanSe true, força o envio mesmo quando há validação prévia falha. O documento entra obrigatoriamente em análise manual.Não

Request body

Exemplo: CNH (Pessoa Física)
Request Body
{
"type": "cnh",
"document_b64": "base64_encoded_document_content",
"file_extension": "pdf",
"document_data": {
"document_type": "CNH",
"issuer_entity": "DETRAN"
}
}
Exemplo: RG (frente e verso)
Request Body — Frente
{
"type": "rg_front",
"document_b64": "base64_encoded_document_content",
"file_extension": "jpeg",
"document_data": {
"document_type": "RG",
"issuer_entity": "SSP",
"document_number": "20.932.206-8"
}
}
Request Body — Verso
{
"type": "rg_back",
"document_b64": "base64_encoded_document_content",
"file_extension": "jpeg"
}
Exemplo: Cartão CNPJ (Pessoa Jurídica)
Request Body
{
"type": "cnpj_card",
"document_b64": "base64_encoded_document_content",
"file_extension": "pdf"
}

Body params

CampoTipoDescriçãoCaracteresObrigatório
typestringEnumerador de Document Type-Sim
document_b64stringConteúdo do arquivo codificado em base64-Sim
file_extensionstringExtensão do arquivo. Valores aceitos: pdf, jpeg-Sim
document_dataobjectMetadados livres do documento (ex.: número, órgão emissor)-Não
observationstringObservação livre sobre o documentoaté 500Não

Document Type

Identificação e comprovantes de pessoa física

EnumeradorDescriçãoExtensões
cnhCNHpdf, jpeg
rg_frontRG — frentepdf, jpeg
rg_backRG — versopdf, jpeg
passportPassaporte (identificação de estrangeiro)pdf, jpeg
foreign_idDocumento de identidade estrangeiro (ex.: RNE)pdf, jpeg
proof_of_residenceComprovante de residênciapdf, jpeg
billing_statementFatura / extratopdf, jpeg

Documentos societários de pessoa jurídica

EnumeradorDescriçãoExtensões
cnpj_cardCartão CNPJpdf, jpeg
social_contractContrato socialpdf, jpeg
company_statuteEstatutopdf, jpeg
board_election_recordAta de eleição estatutáriapdf, jpeg
financial_statementsDemonstrações financeiraspdf, jpeg
organizational_chartOrganograma societáriopdf, jpeg

Representação, qualificação e contratos

EnumeradorDescriçãoExtensões
power_of_attorneyProcuraçãopdf, jpeg
investor_qualification_proofComprovação de qualificação / enquadramentopdf, jpeg
wallet_manager_contractContrato de carteira administrada / intermediaçãopdf, jpeg
extra_documentDocumento avulso, sem tipo específicopdf, jpeg

Investidor não residente

EnumeradorDescriçãoExtensões
custody_contractContrato de custódiapdf, jpeg
representation_contractContrato de representaçãopdf, jpeg
simplified_declarationDeclaração simplificadapdf, jpeg
final_departure_tax_returnDeclaração final de saída definitiva do paíspdf, jpeg
Tipos gerados pela QI Tech

Os tipos qualified_investor_term, professional_investor_term, natural_person_registry_form, legal_person_registry_form, investor_suitability_form e adhesion_term aparecem na consulta do investidor, mas são gerados pela QI Tech para assinatura — não devem ser enviados por este endpoint.

Documentos Obrigatórios

As combinações abaixo são conjuntos alternativos: basta satisfazer uma das opções de cada lista. A validação roda no envio para análise (submit) e recusa com IVR000029, devolvendo na mensagem a matriz exata que faltou.

Pessoa Física (natural_person)

Uma das opções:

OpçãoDocumentos
1cnh + proof_of_residence
2rg_front + rg_back + proof_of_residence

Uma das opções — sempre ao menos um documento societário e as demonstrações financeiras:

OpçãoDocumentos
1board_election_record + financial_statements
2company_statute + financial_statements
3social_contract + financial_statements

O documento societário exigido depende do tipo jurídico da empresa — daí as três opções. Não é possível enviar apenas financial_statements.

Documentos obrigatórios

Embora esses documentos sejam o mínimo para envio de uma análise, caso, por exemplo, somente o company_statute não seja suficiente para definir firmas e poderes do cotista, a análise pode ser recusada exigindo também o board_election_record.

Pessoa Jurídica — Fundo de Investimento (investor_sub_type: fund_class)

Nenhum documento é exigido. Os dados do fundo são obtidos por enriquecimento na base da CVM, e a representação é feita pelos investor owners (administrador e gestora).

Reenvio e documento duplicado

Um tipo de documento é considerado satisfeito assim que existe, para aquela análise, um documento daquele tipo com status valid ou in_manual_analysis. A partir daí, novos envios do mesmo tipo são recusados:

HTTP 409
{
"title": "Already exists valid document for investor analysis.",
"code": "IVR000023"
}

Enquanto todos os documentos de um tipo estiverem invalid, novos envios daquele tipo continuam sendo aceitos — é assim que se corrige um arquivo ilegível.

O tipo extra_document é a única exceção: aceita múltiplos envios sempre.

Validação automática e status do documento

Documentos dos tipos cnh, rg_front, rg_back e proof_of_residence passam por validação automática (OCR) e voltam com um dos status abaixo. Os demais tipos entram diretamente em in_manual_analysis.

StatusSignificado
validValidado automaticamente
in_manual_analysisEncaminhado para conferência humana
invalidReprovado na validação automática — reenvie, ou use force=true

force=true pula o efeito da reprovação automática: o documento é registrado como in_manual_analysis e passa a satisfazer a exigência do tipo.

Sobre investor_qualification_proof

Este documento não integra a matriz de obrigatórios e sua ausência nunca bloqueia o submit. Ele atua depois: se o total_financial_applications declarado estiver abaixo do piso da categoria informada — R$ 1.000.000 para qualified, R$ 10.000.000 para professional — ele é utilizado para a validação. Investidores fund_class são isentos dessa verificação.

Response

Response Body
{
"investor_analysis_document_key": "UUID",
"type": "cnh",
"status": "in_manual_analysis",
"observation": "Documento emitido em 2019, legibilidade reduzida no verso.",
"data": {
"type": "cnh",
"file_extension": "pdf",
"document_data": {
"document_type": "CNH",
"issuer_entity": "DETRAN"
}
},
"investor_analysis": { }
}
CampoTipoDescrição
investor_analysis_document_keystringIdentificador do documento. É a chave usada nas demais rotas de documento
typestringEnumerador de Document Type
statusstringvalid, invalid ou in_manual_analysis — veja Validação automática
observationstringObservação enviada na requisição. null quando não informada
dataobjectEco dos campos enviados, sem o conteúdo em base64
investor_analysisobjectRepresentação completa da análise cadastral — mesmo formato de Busca informações de uma análise cadastral do investidor