跳到主要内容

Consulta Informações do Investidor

Introdução​

Este recurso retorna os dados completos de um investidor — incluindo suas análises cadastrais, lotes de documentos, eventos de status, distribuidor e usuário cadastrador.

Input / Output​

Não há corpo de requisição. As chaves de identificação são passadas no path.

Como output será retornada a representação atual do investidor.

Request​

ENDPOINT
/investor_registry/investor/{investor_key}
MÉTODO
GET
STATUS
200
Endpoints relacionados
  • Listar investidores do agente: GET /investor_registry/investors (paginado, com filtros name, document_number, status).
  • Listar investidores possuídos por um investor owner (uso típico: fund class): GET /investor_registry/investor/{investor_key}/investors.

Response​

Caso 01: Pessoa Física
{
   "investor_key": "UUID",
   "name": "João da Silva",
   "document_number": "123.456.789-00",
   "status": "pending_analysis",
   "email": "joao@example.com",
   "person_type": "natural_person",
   "phone": {
      "number": "987654321",
      "area_code": "11",
      "international_dial_code": "55"
   },
   "distributor": {
      "distributor_key": "UUID",
      "name": "Distribuidor XPTO",
      "document_number": "00.000.000/0000-00"
   },
   "analyses": [
      {
         "investor_analysis_key": "UUID",
         "analysis_datetime": "2025-04-29 12:07:55.059999",
         "status": "pending_registry_data"
      }
   ],
   "document_batches": [],
   "status_events": [
      {
         "status": "pending_analysis",
         "event_datetime": "2025-04-29 12:07:55.000000"
      }
   ]
}
Caso 02: Pessoa Jurídica — Fundo de Investimento
{
   "investor_key": "UUID",
   "name": "Fundo XPTO Multimercado",
   "document_number": "12.345.678/0001-90",
   "status": "registered",
   "person_type": "legal_person",
   "investor_sub_type": "fund_class",
   "distributor": {
      "distributor_key": "UUID",
      "name": "Distribuidor XPTO",
      "document_number": "00.000.000/0000-00"
   },
   "analyses": [
      {
         "investor_analysis_key": "UUID",
         "analysis_datetime": "2025-04-29 12:07:55.059999",
         "status": "manually_approved"
      }
   ],
   "document_batches": [
      {
         "document_batch_key": "UUID",
         "status": "signed",
         "documents": [
            {
               "investor_document_key": "UUID",
               "type": "legal_person_registry_form",
               "status": "signed"
            }
         ]
      }
   ],
   "status_events": [
      {
         "status": "registered",
         "event_datetime": "2025-04-29 13:08:25.673902"
      }
   ]
}

Investor​

CampoTipoDescrição
investor_keystringChave única de identificação do investidor
namestringNome (ou razão social) do investidor
document_numberstringCPF / CNPJ do investidor
emailstringE-mail de contato
phoneobjectObjeto de Phone
statusstringEnumerador de Investor Status
person_typestringEnumerador de Person Type
investor_sub_typestringEnumerador de Investor Sub Type, quando aplicável
distributorobjectObjeto 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_codestringDDD2
numberstringNúmero de telefone8 - 9

Investor Status​

EnumeradorDescrição
createdCriado
pending_analysisPendente análise
pending_documentsPendente documentos
incompleteCadastro incompleto
pending_updatePendente atualização
registeredCadastrado
registry_expiredCadastro expirado

Person Type​

EnumeradorDescrição
natural_personPessoa física
legal_personPessoa jurídica
nomineeNominee / PCO

Investor Sub Type​

EnumeradorDescrição
defaultPessoa jurídica regular
financial_institutionInstituição financeira
fund_classFundo de investimento
non-residentNão-residente

Distributor​

CampoTipoDescrição
distributor_keystringChave única do distribuidor
namestringNome do distribuidor
document_numberstringCNPJ do distribuidor

Investor Analysis​

CampoTipoDescrição
investor_analysis_keystringChave única da análise cadastral
analysis_datetimestringData/hora de criação da análise
statusstringEnumerador de Investor Analysis Status
registry_userobjectObjeto de Registry User, quando presente

Document Batch​

CampoTipoDescrição
document_batch_keystringChave única do lote de documentos
statusstringEnumerador de Document Batch Status
documentsarrayLista de objetos de Investor Document

Investor Document​

CampoTipoDescrição
investor_document_keystringChave única do documento do investidor
typestringEnumerador de Document Type
statusstringEnumerador de Investor Document Status

Registry User​

CampoTipoDescrição
registry_user_keystringChave única do usuário cadastrador
kc_user_idstringID do usuário no KeyCloak
namestringNome
document_numberstringCPF
emailstringE-mail
phoneobjectObjeto de Phone

Investor Analysis Status​

EnumeradorDescrição
createdCriada
pending_registry_dataPendente dados cadastrais
pending_documentsPendente documentos
sent_to_analysisEnviada para análise
in_manual_analysisEm análise manual
automatically_approvedAprovada automaticamente
automatically_reprovedReprovada automaticamente
manually_approvedAprovada manualmente
manually_reprovedReprovada manualmente
expiredExpirada

Document Batch Status​

EnumeradorDescrição
creating_documentsDocumentos sendo gerados
send_to_signatureEnviado para assinatura
pending_signatureAguardando assinatura
signedAssinado

Document Type​

EnumeradorDescrição
cnhCNH
rgRG
rg_backRG — verso
rg_frontRG — frente
proof_of_residenceComprovante de residência
cnpj_cardCartão CNPJ
financial_statementsDemonstrações financeiras
social_contractContrato social
company_statuteEstatuto
board_election_recordAta de eleição
fund_prospectusRegulamento do fundo
power_of_attorneyProcuração
billing_statementFatura / extrato
investor_qualification_proofComprovação de qualificação
qualified_investor_termTermo de investidor qualificado
professional_investor_termTermo 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
signedAssinado

Status Event​

CampoTipoDescrição
statusstringEnumerador de status
event_datetimestringData/hora do evento