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 o par rg_front + rg_back
  • Para pessoa jurídica (parent_company): nenhum documento é exigido
  • Um mesmo type só aceita um envio bem-sucedido: veja Reenvio e documento duplicado

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/investor/{investor_key}/investor_analysis/{investor_analysis_key}/related_party/{external_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 SuportadasUso
cnhCNHpdf, jpegIdentificação (opção 1)
rg_frontFrente do RGpdf, jpegIdentificação (opção 2, com rg_back)
rg_backVerso do RGpdf, jpegIdentificação (opção 2, com rg_front)
passportPassaportepdf, jpegIdentificação de parte estrangeira
foreign_idIdentidade estrangeirapdf, jpegIdentificação de parte estrangeira
power_of_attorneyProcuraçãopdf, jpegComplementar, para attorney

Documentos Obrigatórios

A exigência é avaliada no envio para análise (submit) e recusada com IVR000030. Basta satisfazer uma das opções.

Parte relacionada pessoa física residente

OpçãoDocumentos
1cnh
2rg_front + rg_back

Parte relacionada pessoa física não residente

OpçãoDocumentos
1passport
2foreign_id

Parte relacionada pessoa jurídica (parent_company)

Nenhum documento é exigido.

Procuração

Para uma parte relacionada do tipo attorney, power_of_attorney é obrigatório e complementar: ele é exigido além da identificação, e não a substitui. A parte continua precisando de cnh ou do par rg_front + rg_back. A falta da procuração é recusada com IVR000148.

Reenvio e documento duplicado

Um tipo é considerado satisfeito assim que existe, para aquela parte relacionada, um documento daquele tipo com status valid ou in_manual_analysis. Novos envios do mesmo tipo passam a ser recusados:

HTTP 409
{
"title": "Already exists valid document for related party.",
"code": "IVR000141"
}

Enquanto todos os documentos de um tipo estiverem invalid, novos envios continuam sendo aceitos.

Response

Response Body
{
"related_party_document_key": "UUID",
"status": "in_manual_analysis"
}
Validação automática

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

  • valid: validado automaticamente
  • invalid: reprovado na validação automática
  • in_manual_analysis: encaminhado para conferência humana

Para documentos reprovados, é possível forçar o envio usando o parâmetro force=true. Ao utilizar essa flag o documento será submetido para avaliação manual, necessariamente — e passa a satisfazer a exigência do tipo.