Skip to main content

Query Investor Information

Introduction​

This resource returns the complete data of an investor — including their registration analyses, document batches, status events, distributor and registering user.

Input / Output​

There is no request body. The identification keys are passed in the path.

As output, the current representation of the investor is returned.

Available on
ProfileHost
Distributordistributor-api

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/investor_registry/investor/{investor_key}
METHOD
GET
STATUS
200
Related endpoints
  • List the agent's investors: GET /investor_registry/investors (paginated, with name, document_number, status filters).
  • List investors owned by an investor owner (typical use: fund class): GET /investor_registry/investor/{investor_key}/investors.

Response​

Case 01: Natural Person
{
   "investor_key": "UUID",
   "name": "João da Silva",
   "document_number": "969.698.790-03",
   "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": "33.444.555/0001-81"
   },
   "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"
      }
   ]
}
Case 02: Legal Entity — Investment Fund
{
   "investor_key": "UUID",
   "name": "Fundo XPTO Multimercado",
   "document_number": "22.333.444/0001-81",
   "status": "registered",
   "person_type": "legal_person",
   "investor_sub_type": "fund_class",
   "distributor": {
      "distributor_key": "UUID",
      "name": "Distribuidor XPTO",
      "document_number": "33.444.555/0001-81"
   },
   "analyses": [
      {
         "investor_analysis_key": "UUID",
         "analysis_datetime": "2025-04-29 12:07:55.059999",
         "status": "manually_approved",
         "registry_user": {
            "registry_user_key": "UUID",
            "kc_user_id": "UUID",
            "name": "João da Silva",
            "document_number": "969.698.790-03",
            "email": "joao.silva@example.com",
            "phone": {
               "number": "123456789",
               "area_code": "11",
               "international_dial_code": "55"
            }
         }
      }
   ],
   "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​

FieldTypeDescription
investor_keystringUnique identification key of the investor
namestringName (or corporate name) of the investor
document_numberstringInvestor CPF / CNPJ
emailstringContact e-mail
phoneobjectPhone object
statusstringInvestor Status enumerator
person_typestringPerson Type enumerator
investor_sub_typestringInvestor Sub Type enumerator, when applicable
distributorobjectDistributor object
analysesarrayList of Investor Analysis objects
document_batchesarrayList of Document Batch objects
status_eventsarrayList of Status Event objects

Phone​

FieldTypeDescriptionCharacters
international_dial_codestringInternational code1 - 3
area_codestringArea code (DDD)2
numberstringPhone number8 - 9

Investor Status​

EnumeratorDescription
createdCreated
pending_analysisPending analysis
pending_documentsPending documents
incompleteIncomplete registration
pending_updatePending update
registeredRegistered
registry_expiredRegistration expired

Person Type​

EnumeratorDescription
natural_personNatural person
legal_personLegal entity
nomineeNominee / PCO

Investor Sub Type​

EnumeratorDescription
defaultRegular legal entity
financial_institutionFinancial institution
fund_classInvestment fund
non-residentNon-resident

Distributor​

FieldTypeDescription
distributor_keystringUnique key of the distributor
namestringDistributor name
document_numberstringDistributor CNPJ

Investor Analysis​

FieldTypeDescription
investor_analysis_keystringUnique key of the registration analysis
analysis_datetimestringAnalysis creation date/time
statusstringInvestor Analysis Status enumerator
registry_userobjectRegistry User object, when present

Document Batch​

FieldTypeDescription
document_batch_keystringUnique key of the document batch
statusstringDocument Batch Status enumerator
documentsarrayList of Investor Document objects

Investor Document​

FieldTypeDescription
investor_document_keystringUnique key of the investor document
typestringDocument Type enumerator
statusstringInvestor Document Status enumerator

Registry User​

FieldTypeDescription
registry_user_keystringUnique key of the registering user
kc_user_idstringIdentifier of the investor's access user
namestringName
document_numberstringCPF
emailstringE-mail
phoneobjectPhone object

Investor Analysis Status​

EnumeratorDescription
createdCreated
pending_registry_dataPending registration data
pending_documentsPending documents
sent_to_analysisSent for analysis
in_manual_analysisIn manual analysis
automatically_approvedAutomatically approved
automatically_reprovedAutomatically rejected
manually_approvedManually approved
manually_reprovedManually rejected
expiredExpired

Document Batch Status​

EnumeratorDescription
creating_documentsDocuments being generated
send_to_signatureSent for signature
pending_signatureWaiting for signature
signedSigned

Document Type​

EnumeratorDescription
cnhCNH (driver's license)
rgRG (ID card)
rg_backRG — back
rg_frontRG — front
proof_of_residenceProof of residence
cnpj_cardCNPJ card
financial_statementsFinancial statements
social_contractArticles of association
company_statuteBylaws
board_election_recordBoard election minutes
fund_prospectusFund regulation
power_of_attorneyPower of attorney
billing_statementInvoice / statement
investor_qualification_proofProof of qualification
qualified_investor_termQualified investor term
professional_investor_termProfessional investor term
natural_person_registry_formRegistration form — natural person
legal_person_registry_formRegistration form — legal entity

Investor Document Status​

EnumeratorDescription
sent_to_generateSent to be generated
generatedGenerated
signedSigned

Status Event​

FieldTypeDescription
statusstringStatus enumerator
event_datetimestringEvent date/time

Errors​

StatusCodeWhen it happens
404IVR000008Investor not found
400QIT000011The investor is not linked to your integration

Authentication, permission and host errors: see API Errors.