Opening a Personal Account
As the second step of the individual account opening, after the account reservation, the complete registration data of the holder and evidence of acceptance of the account opening terms must be sent.
Request
ENDPOINT
/account_request/checkingMETHOD
POSTPath Params
Field | Type | Description | Characters |
---|---|---|---|
account_request_key | uuidv4 | Unique key for account reservation request. | 36 |
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",
"document_identification": "3884579b-9810-4fa6-9b08-fe67d237160a",
"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"
},
"proof_of_residence": "4d7f4e-1eec-4e5f-82c0-d8c3921497ea"
},
"signed_contract": {
"document_key": "48a8f4g9-4b58-4905-9a69-b1f9215263f5",
"signatures": [
{
"authenticity": {
"timestamp": "1970-01-01T00:00:01.080100Z",
"facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb",
"lang": "-35.8916627",
"lat": "-7.2226067",
"ip_address": "177.51.1.186",
"session_id": "jdifj329842"
},
"signer": {
"name": "Nome do Titular da Conta",
"email": "teste@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "999999999"
},
"authentication_type": "opt-in"
}
]
},
"additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}
Request Body Params
Field | Type | Description | Characters |
---|---|---|---|
account_owner * | object | Object containing the Account Holder's information | Object account_owner |
signed_contract * | object | Object containing the evidence of the Holder's acceptance of the account opening terms. | Object signed_contract |
additional_documents * | list | Lista com as document_key (uuidv4) dos documentos adicionais do titular da conta. | 36 |
Object account_owner
Field | Type | Description | Characters |
---|---|---|---|
address * | string | Account Holder's Address. | Object address |
birth_date * | string | Account Holder's birth date (format "YYYY-MM-DD") | 10 |
document_identification * | string | DOCUMENT-KEY of the identification document with photo (.pdf, .jpeg, .jpg, .png) of the individual (RG or CNH). The DOCUMENT-KEY is obtained through the document upload de documentos | |
document_identification_type * | string | Type of document previously sent (RG or CNH) | |
email * | string | Customer's email. | |
individual_document_number | string | Individual's CPF (only numbers). Limited to 11 characters. | |
is_pep * | string | Declaration if the person is a PEP (Brazilian acronyms for a politically related person) (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | |
mother_name * | string | Mother's name of the customer in case of an individual. | 100 |
name * | string | Company name in case of corporate operations or individual's name in case of personal operations. | 100 |
nationality * | string | Customer's nationality. | 50 |
person_type * | string | Identifier if the submitted object is an individual or a company. | |
phone * | string | Object with phone data | Object phone |
proof_of_residence | string | DOCUMENT_KEY of the PDF proof of address for the address provided (previously submitted). |
Object address
Field | Type | Description | Characters |
---|---|---|---|
street * | string | Street address | 100 |
state * | string | State address (two uppercase characters) | 2 |
city * | string | City address | 100 |
neighborhood * | string | Neighborhood address | 100 |
number * | string | Street number | 10 |
postal_code * | string | ZIP code (http://www.buscacep.correios.com.br/sistemas/buscacep/) (numbers only) | 8 |
complement * | string | Address complement (free text) | 100 |
Object signed_contract
Field | Type | Description | Characters |
---|---|---|---|
document_key * | uuidv4 | Unique identification key of the Account Opening Term or Escrow Account Contract document. (The DOCUMENT_KEY is returned in the response of the Document Upload endpoint) | 36 |
signatures * | list | Signature data of the submitted document. Each item in the list corresponds to a signer of the document. | Object signatures |
Object signatures
Field | Type | Description | Characters |
---|---|---|---|
authenticity * | object | Set of data that evidence the electronic signature made by the signer. | Object authenticity |
signer * | object | Object containing the data of one of the document's signers. | Object signer |
authentication_type * | enumerator | Type of signature. Always will be "opt-in" | "opt-in" |
Object authenticity
Field | Type | Description | Characters |
---|---|---|---|
timestamp * | string | Date and time of the document signing moment. | 27 |
facial_recognition_key | uuidv4 | Unique identification key of the account holder's selfie photo. (The DOCUMENT_KEY is returned in the response of the Document Upload endpoint) | 36 |
lang | string | Longitude coordinate of the signer's geolocation captured at the time of signing. | - |
lat | string | Latitude coordinate of the signer's geolocation captured at the time of signing. | - |
ip_address | string | IP address of the signer's device. | - |
session_id | string | Session ID of the signer at the time of signing. | - |
Object signer
Field | Type | Description | Characters |
---|---|---|---|
name * | string | Signer's name. | - |
email * | string | Signer's email. | - |
phone * | object | Object with the signer's phone data | Object phone |
document_number * | string | Signer's CPF. | 11 |
Object phone
Field | Type | Description | Characters |
---|---|---|---|
country_code * | string | Country phone code (https://ddi.guiamais.com.br/) | 3 |
area_code * | string | Area phone code (https://ddd.guiamais.com.br/) | 2 |
number * | string | Phone number (numbers only) | 10 |
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!
Attention: The account_request_key
field 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 | Identification key for the account creation request | - |
account_request_status * | string | KYC Status | - |
Object account_info
Field | Type | Description | Characters |
---|---|---|---|
account_branch * | string | Bank branch number | 4 |
account_digit * | string | Bank account verification digit | 11 |
account_number * | string | Bank account number | 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 (pt-br)translation |
---|---|---|---|---|
400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
404 | QIT000404 | Not Found | Resource could not be found | Recurso não encontrado |