Request a Corporate Account
Account opening occurs in two mandatory stages. First, a POST request sends preliminary data to reserve the account. Then, a webhook of type account_request.status_change
with the status pending_additional_data
is triggered. In the second stage, a PATCH request completes the opening, officially establishing the account with the additional information.
Request
ENDPOINT
/account_request/checkingMETHOD
POSTRequest Body
{
"account_owner": {
"document_number": "99999999999",
"email": "email@teste.com",
"birthdate": "2017-09-16",
"name": "Titular da Conta"
}
}
Request Body Params
Field | Type | Description | Characters |
---|---|---|---|
account_owner * | object | Object containing the Account Holder's information | Object account_owner |
Object account_owner
Field | Type | Description | Characters |
---|---|---|---|
document_number * | string | Account Holder's CPF | 50 |
email * | string | 11 | |
birthdate * | string | Account Holder's birthdate (format YYYY-MM-DD) | 10 |
name * | string | Account Holder's Full Name | 50 |
Response
STATUS
201Response Body
{
"account_info": {
"account_branch": "0001",
"account_digit": "0",
"account_number": "1693580"
},
"account_request_key": "f230f1b5-07af-4737-b0e3-8a472304f5e7",
"account_request_status": "pending_kyc_analysis"
}
Warning!
The field account_request_key
must be stored and will be used for account opening confirmation.
Response Body Params
Field | Type | Description | Characters |
---|---|---|---|
account_info * | object | Object containing the Account Holder's information | Object account_info |
account_request_key * | string | Key for identifying the creation request | - |
account_request_status * | string | KYC Status | - |
Object account_info
Field | Type | Description | Characters |
---|---|---|---|
account_branch * | string | Branch Number | 4 |
account_digit * | string | 11 | |
account_number * | string | Account Holder's Full Name | 50 |
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 |