Request account reservation
Request
ENDPOINT
/account_request/draft_checkingMETHOD
POSTAccount Opening
Request Body
{
"account_owner":{
"address":{
"street":"Av. Brigadeiro Faria Lima",
"state":"SP",
"city":"São Paulo",
"neighborhood":"Jardim Paulistano",
"number":"2391",
"postal_code":"01452905",
"complement":"Complemento"
},
"birth_date":"1990-05-06",
"email":"teste@gmail.com",
"individual_document_number":"99999999999",
"is_pep":false,
"mother_name":"Dona Maria Mariane",
"name":"Nome do Titular da Conta",
"nationality":"nationality",
"person_type":"natural",
"phone":{
"country_code":"055",
"area_code":"11",
"number":"999999999"
},
"monthly_income":1000
}
}
Account Opening
Request Body Params
| Field | Type | Description |
|---|---|---|
account_owner* | object | Account holder details, including address and personal information. |
account_owner Object
| Field | Type | Description |
|---|---|---|
address* | object | Account holder's address. |
birth_date* | string | Account holder's birth date (format "YYYY-MM-DD"). |
email* | string | Account holder's email. |
individual_document_number* | string | Account holder's CPF (numbers only). |
is_pep* | boolean | Declaration if the person is a PEP. |
mother_name* | string | Account holder's mother's name. |
name* | string | Account holder's full name. |
nationality | string | Account holder's nationality. |
person_type* | enum | Person type, must always be "natural" for natural person. |
phone* | object | Account holder's phone number. |
monthly_income | number | Account holder's monthly income. |
address Object
| Field | Type | Description | Characters |
|---|---|---|---|
street* | string | Address street | - |
state* | enum | Address state | 2 |
city* | string | Address city | - |
neighborhood* | string | Address neighborhood | - |
number* | string | Street number | - |
postal_code* | string | Address ZIP code | - |
complement | string | Address complement | - |
phone Object
| Field | Type | Description |
|---|---|---|
country_code* | string | Phone country code |
area_code* | string | Phone area code |
number* | string | Phone number |
person_type Enumerators
| Enum | Description |
|---|---|
natural | Natural person |
legal | Legal entity |
Response
STATUS
201Response Body
{
"account_number": "1638634",
"reserved_account_status":"reserved",
"account_type": "checking",
"account_digit": "3",
"account_key": "b1690f7b-1e82-4f76-a8d3-c326a2b89b67",
"account_branch": "0001",
"account_name": "Nome do Proprietário",
"created_at": "2023-10-07T15:52:24"
}
Attention
The account_request_key field must be stored and will be used to confirm the account opening.
Response Body Params
| Field | Type | Description | Characters |
|---|---|---|---|
account_key * | string | Account unique identification key | - |
STATUS
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP Codestatus | QI Codecode | Titletitle | Description (eng)description | Description(ptbr) translation |
|---|---|---|---|---|
| 400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
| 404 | QIT000404 | Not Found | Resource could not be found | Recurso não encontrado |