Skip to main content

Consulta informações do investidor

Introdução​

Este recurso tem como objetivo fornecer os dados de um investidor.

Input / Output:​

Não existe um body como input deste recurso, somente a chave de identificação investidor (investor_key) deve ser passada no path.

Como output será entregue a representação de cada um dos dados do investidor presente em nosso sistema. Abaixo segue um exemplo.

Request​

ENDPOINT
/investor_registry/investor/INVESTOR_KEY
MÉTODO
GET
STATUS
200

Responses​

Caso 01: investidor pessoa física pendente análise cadastral
{
   "investor_key":"UUID",
   "name":"Sample Investor Name",
   "document_number":"000.000.000-00",
   "status":"pending_analysis",
   "email":"sample@mail.com.br",
   "phone":{
      "number":"123456789",
      "area_code":"11",
      "international_dial_code":"055"
   },
   "distributor":{
      "distributor_key":"UUID",
      "name":"Sample Distributor Name",
      "document_number":"00.000.000/0000-00"
   },
   "analyses":[
      {
         "investor_analysis_key":"308af5df-38ff-4b38-941e-aadc6e4804f8",
         "analysis_datetime":"2024-11-25 13:42:40.003782",
         "status":"pending_registry_data"
      }
   ],
   "document_batches":[
      {
         "document_batch_key":"308af5df-38ff-4b38-941e-aadc6e4804f8",
         "status":"creating_documents | pending_signer_groups | send_to_signature | pending_signature",
         "documents":[
            {
               "investor_document_key":"UUID",
               "type":" cnh | rg | rg_back | rg_front | proof_of_residence | cnpj_card | financial_statements | power_of_attorney | billing_statement | social_contract |qualified_investor_term | professional_investor_term | natural_person_registry_form | legal_person_registry_form ",
               "status":"generated"
            }
         ]
      }
   ],
   "status_events":[
      {
         "status":"pending_analysis",
         "event_datetime":"2024-11-25 13:42:40.013357"
      }
   ],
   "person_type":"natural_person"
}
Caso 02: investidor pessoa jurídica pendente análise cadastral
{
   "investor_key":"UUID",
   "name":"Sample Investor Name",
   "document_number":"00.000.000/0000-00 | 000.000.000-00",
   "status":"pending_analysis",
   "person_type":"legal_person",
   "distributor":{
      "distributor_key":"UUID",
      "name":"Sample Distributor Name",
      "document_number":"00.000.000/0000-00"
   },
   "email":"sample@mail.com.br",
   "phone":{
      "number":"123456789",
      "area_code":"11",
      "international_dial_code":"055"
   },
   "analyses":[
      {
         "investor_analysis_key":"UUID",
         "agent_key":"UUID",
         "analysis_datetime":"2024-11-25 13:08:25.649543",
         "status":"pending_registry_data",
         "registry_user":{
            "registry_user_key":"UUID",
            "kc_user_id":"UUID",
            "name":"Sample Investor Name",
            "document_number":"000.000.000-00",
            "email":"sample@email.com.br",
            "phone":{
               "number":"123456789",
               "area_code":"11",
               "international_dial_code":"055"
            }
         }
      }
   ],
   "document_batches":[
      {
         "document_batch_key":"308af5df-38ff-4b38-941e-aadc6e4804f8",
         "status":"creating_documents | send_to_signature | pending_signature",
         "documents":[
            {
               "investor_document_key":"UUID",
               "type":" cnh | rg | rg_back | rg_front | proof_of_residence | cnpj_card | financial_statements | power_of_attorney | billing_statement | social_contract |qualified_investor_term | professional_investor_term | natural_person_registry_form | legal_person_registry_form ",
               "status":"sent_to_generate | generated"
            }
         ]
      }
   ],
   "status_events":[
      {
         "status":"pending_analysis",
         "event_datetime":"2024-11-25 13:08:25.673902"
      }
   ],
}

Investor​

CampoTipoDescriçãoCaracteres
investor_keystringChave única de identificação do investidor36
namestringNome do investidoraté 255
document_numberstringCPF / CNPJ do investidor14 ou 18
emailstringEmail do investidor-
phonestringObjeto de Phone-
statusstringEnumerador de status do cadastro do investidor-
person_typestringEnumerador de pessoa física ou pessoa jurídica do investidor-
distributorJSONObjeto de Distributor-
analysesarrayLista de objetos de Investor Analysis-
document_batchesarrayLista de objetos de Document Batch-
status_eventsarrayLista de objetos de Status Event-

Phone​

CampoTipoDescriçãoCaracteres
international_dial_codestringCódigo internacional1 - 3
area_codestringCódigo de área2
numberstringNúmero de telefone8 - 9

Investor Status​

EnumeradorDescrição
pending_analysisPendente análise
pending_documentsPendente documentos
pending_updatePendente atualização
registeredCadastrado

Person Type​

EnumeradorDescrição
natural_personPessoa física
legal_personPessoa jurídica

Distributor​

CampoTipoDescriçãoCaracteres
namestringNome do distribuidoraté 255
distributor_keystringChave única de identificação do distribuidor-
document_numberstringCPF/CNPJ do distribuidor14 ou 18

Investor Analysis​

CampoTipoDescriçãoCaracteres
investor_analysis_keystringChave única de identificação da análise cadastral do investor36
analysis_datetimestringData e Hora em que a análise cadastral foi criada-
statusstringEnumerador de status da análise cadastral-
registry_userJSONObjeto de Registry User-

Document Batch​

CampoTipoDescriçãoCaracteres
document_batch_keystringChave única de identificação do lote de documentos36
statusstringEnumerador de status do lote de documentos-
documentsArrayLista de objetos de Investor Document-

Investor Document​

CampoTipoDescriçãoCaracteres
investor_document_keystringChave única de identificação do documento do investidor36
typestringEnumerador de tipo de documento do investidor-
statusstringEnumerador de status do documento do investidor-

Registry User​

CampoTipoDescriçãoCaracteres
registry_user_keystringChave única de identificação do usuário cadastrador36
kc_user_idstringChave única de identificação do usuário no KeyCloak-
namestringNome do distribuidoraté 255
document_numberstringCPF/CNPJ do distribuidor14 ou 18
phoneJSONObjeto de Phone-

Investor Analysis Status​

EnumeradorDescrição
pending_registry_dataPendente dados cadastrais
pending_documentsPendente documentos
sent_to_analysisEnviado para análise
in_manual_analysisEm análise manual
approvedAprovado
reprovedReprovado

Document Batch Status​

EnumeradorDescrição
creating_documentsCriando documentos
send_to_signatureEnviado para assinatura
pending_signaturePendente assinatura

Document Type​

EnumeradorDescrição
cnhCNH
rgRG
rg_backRG - Trás
rg_frontRG - Frente
proof_of_residenceComprovante de residência
cnpj_cardCartão CNPJ
financial_statementsDemonstrações financeiras
power_of_attorneyProcuração
billing_statementComprovante de renda
social_contractContrato social
qualified_investor_termDeclaração de investidor qualificado
professional_investor_termDeclaração de investidor profissional
natural_person_registry_formFicha cadastral - Pessoa física
legal_person_registry_formFicha cadastral - Pessoa jurídica

Investor Document Status​

EnumeradorDescrição
sent_to_generateEnviado para ser gerado
generatedGerado

Status Event​

CampoTipoDescriçãoCaracteres
statusstringEnumerador de Investor Status-
event_datetimestringData e Hora em que a atualização de status foi realizada-