Send Investor Address
Introduction
This resource is used to send the address that is part of an investor's registration analysis.
fund_class) — step skippedFund classes do not send an address. The address is automatically inherited from the administrator linked to the class when the registration is sent for analysis, and the submit does not require the address block for this sub-type. Skip this step.
Input / Output
As input, send the address data.
As output, the analysis data object is returned, with the registration blocks already saved.
Request
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/addressPUT202Example
{
"street": "Avenida Paulista",
"number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"postal_code": "01310-100",
"uf": "SP",
"country": "BRA",
"complement": "Sala 1010"
}
Body params
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
street | string | Street | 1 - 255 | Yes |
number | string | Number (digits only) | 1 - 10 | Yes |
neighborhood | string | Neighborhood | 1 - 255 | Yes |
city | string | City | 1 - 255 | Yes |
postal_code | string | Postal code. In Brazil, CEP in the NNNNN-NNN format. Abroad, the country's local format | 1 - 20 | Yes |
uf | string | Federative Unit (state) — e.g. SP, CE, MG. Abroad, use EX | 1 - 20 | Yes |
country | string | ISO country code, 3 letters — e.g. BRA, PRT | 3 | Yes |
complement | string | Complement | 1 - 255 | No |
Address abroad
The validation of country, uf and postal_code depends on the analysis residence:
Analysis resident | country | uf | postal_code |
|---|---|---|---|
true (default) | must be BRA (IVR000227) | Brazilian UF code — e.g. SP, RJ (IVR000273) | CEP in the NNNNN-NNN format, 8 digits with hyphen (IVR000281) |
false | any, except BRA (IVR000226) | no format validation | no format validation |
For an address abroad, postal_code and uf accept any country's standard (up to 20 characters each): a Portuguese postal code 1000-001 or a US ZIP 10001 are accepted as they are.
resident is not a field of this step and cannot be changed later. If you receive IVR000227 when sending an address abroad, the analysis was created as resident — you need to create the investor with resident: false and non_resident_type, as described in the Non-resident investor section of the Create Investor page.
Response
The body carries the analysis data object with the blocks already saved. For the status and other fields, see Query Information of an Investor Registration Analysis.
Errors
| Status | Code | When it happens |
|---|---|---|
| 400 | IVR000018 | The analysis is no longer in pending_registry_data (it has already been sent or closed) |
| 400 | IVR000227 | Resident investor with country other than BRA |
| 400 | IVR000226 | Non-resident investor with country: BRA |
| 400 | IVR000273 | Resident investor with a uf that is not a Brazilian UF code |
| 400 | IVR000281 | Resident investor with a CEP not in the NNNNN-NNN format |
| 400 | QIT000011 | Through the manager (manager-api): the investor is not a fund class linked to it |
Authentication, permission and host errors: see API Errors.