Create investor
Introduction
This resource is used to provide us with the basic data to start the registration of an investor.
Creating an investor also triggers the opening of a first registration analysis linked to it. For this reason, at the end of this call two keys are returned: investor_key (identifies the investor) and investor_analysis_key (identifies the registration analysis in progress).
In sandbox, the analysis result depends on the first digit of the CPF/CNPJ: starting with 1 → automatic rejection; starting with 8 → manual analysis; all others are automatically approved.
Input / Output
As input, send the investor's basic data. The required fields vary according to person_type and investor_sub_type.
As output, the investor_key and the investor_analysis_key are returned. The investor_key identifies the investor; the investor_analysis_key identifies the registration analysis opened along with the creation. The same investor may have more than one registration analysis over time (renewals, updates).
| Profile | Host |
|---|---|
| Investor | investor-api |
Base URL for each host: Environments (Hosts).
Request
/investor_registry/investorPOST201Request body
Case 01: Natural Person
{
"name": "João da Silva",
"document_number": "969.698.790-03",
"person_type": "natural_person",
"email": "joao.silva@example.com",
"phone": {
"international_dial_code": "55",
"area_code": "11",
"number": "987654321"
},
"investor_owner_type": "wallet_manager"
}
Case 02: Legal Entity
{
"name": "Empresa XPTO Ltda",
"document_number": "22.333.444/0001-81",
"person_type": "legal_person",
"investor_sub_type": "default",
"investor_owner_type": "wallet_manager"
}
The required fields change according to the person_type. The absence of any of them is rejected with IVR000009.
natural_person:name,document_number,person_typeand, wheninvestor_owner_typeis not sent,emailandphonelegal_person:name,document_number,person_type
investor_owner_type is required for the portfolio manager: without it, the call is rejected with IVR000153. With it, email and phone are not required for natural_person.
investor_sub_type is optional; non_resident is rejected with IVR000255.
Body params
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
name | string | Name (or corporate name) of the investor | 1 - 255 | Yes |
person_type | string | Person Type enumerator | - | Yes |
document_number | string | CPF (XXX.XXX.XXX-XX) or CNPJ (XX.XXX.XXX/XXXX-XX) | 14 or 18 | Yes* |
investor_sub_type | string | Investor Sub Type enumerator | - | No |
email | string | Investor e-mail. Required for natural_person without investor_owner_type | 1 - 255 | Conditional |
phone | object | Phone object. Required for natural_person without investor_owner_type | - | Conditional |
investor_owner_type | string | Type of relationship with the created investor - Investor Owner Type enumerator | 1 - 255 | Yes |
Phone
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
international_dial_code | string | International code (e.g. 55) | 1 - 3 | Yes |
area_code | string | Area code (DDD) | 2 | Yes |
number | string | Phone number | 8 - 9 | Yes |
Person Type
| Enumerator | Description |
|---|---|
natural_person | Natural person |
legal_person | Legal entity |
Investor Sub Type
| Enumerator | Description |
|---|---|
default | Regular legal entity (default when the field is not provided) |
Investor Owner Type
| Enumerator | Description |
|---|---|
wallet_manager | Portfolio Manager |
Response
{
"investor_key": "UUID",
"investor_analysis_key": "UUID"
}
Errors
| Status | Code | When it happens |
|---|---|---|
| 400 | IVR000004 | CPF/CNPJ with an invalid check digit, or CPF sent with legal_person (and vice versa) |
| 400 | IVR000009 | A required field for the person_type is missing |
| 400 | IVR000153 | investor_owner_type not sent |
| 400 | IVR000255 | investor_sub_type: non_resident. Use resident: false and non_resident_type |
| 400 | IVR000258 / IVR000259 | default sub-type declared for a CNPJ that is a registered financial institution or a class at CVM |
| 409 | IVR000007 | You have already registered an investor with this document |
Authentication, permission and host errors: see API Errors.