Pular para o conteúdo principal

Enviar Documento da Parte Relacionada


Introdução

Este recurso tem como objetivo fazer upload dos documentos obrigatórios de cada parte relacionada criada.

Atenção
  • Este endpoint deve ser chamado para cada parte relacionada criada que seja pessoa física
  • A parte relacionada deve estar com status "active" para receber documentos
  • Para pessoa física: é obrigatório enviar um documento de identificação (cnh ou rg)
  • Para tipo attorney (procurador): é obrigatório enviar power_of_attorney (procuração)

Input / Output:

Como input deve ser enviado o documento em base64, o tipo do documento e a extensão do arquivo.

Como output será entregue uma related_party_document_key que identifica o documento enviado.

Request

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

Request body

Exemplo: Documento de Identificação (CNH)
Request Body
{
"type": "cnh",
"document_b64": "base64_encoded_document_content",
"file_extension": "pdf"
}
Exemplo: RG (Frente e Verso)
Request Body - Frente
{
"type": "rg_front",
"document_b64": "base64_encoded_document_content",
"file_extension": "pdf"
}
Request Body - Verso
{
"type": "rg_back",
"document_b64": "base64_encoded_document_content",
"file_extension": "pdf"
}
Exemplo: Procuração (para tipo attorney)
Request Body
{
"type": "power_of_attorney",
"document_b64": "base64_encoded_document_content",
"file_extension": "pdf"
}

Body params

CampoTipoDescriçãoCaracteresObrigatório
typestringTipo de documento1 - 50Sim
document_b64stringBase 64 do documento-Sim
file_extensionstringExtensão do arquivo (pdf, png, jpeg)1 - 10Sim
EnumeradorDescriçãoExtensões SuportadasObrigatório Para
cnhCNHpdf, jpegPessoa física (uma opção)
rgRGpdf, jpegPessoa física (uma opção)
rg_backVerso do RGpdf, jpegPessoa física (com rg_front)
rg_frontFrente do RGpdf, jpegPessoa física (com rg_back)
power_of_attorneyProcuraçãopdf, jpegTipo attorney

Documentos Obrigatórios

DocumentoDescriçãoTipo de Parte Relacionada
cnh ou (rg_front + rg_back)Documento de identificaçãoPessoa física
power_of_attorneyProcuraçãoTipo attorney

Response

Response Body
{
"related_party_document_key": "UUID",
"status": "valid | invalid | in_manual_analysis"
}
Informação

O documento será validado automaticamente após o upload. O status pode ser:

  • valid: Documento válido
  • invalid: Documento inválido
  • in_manual_analysis: Em análise manual

Para documentos inválidos, é possível forçar o envio usando o parâmetro force=true. No entanto, ao utilizar essa flag o documento será submetido para avaliação manual, necessariamente.