Opening a Corporate Account
As the second step of the corporate 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": {
"phone": {
"country_code": "55",
"area_code": "11",
"number": "999999999"
},
"email": "email@teste.com.br",
"person_type": "legal",
"name": "Empresa de Teste",
"address": {
"street": "Rua Abrahão Calux",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Vila Teste",
"number": "116",
"postal_code": "04286100",
"complement": "Complemento"
},
"trading_name": "Nome fantasia",
"company_document_number": "99999999000130",
"cnae_code": "4721102",
"foundation_date": "1980-07-11",
"company_statute": "99999999-01c9-4cf5-a0fa-1d2a96f4b34d",
"company_representatives": [
{
"name": "Nome do Socio",
"individual_document_number": "99999999999",
"document_identification_number": "999999999",
"birth_date": "1989-09-01",
"mother_name": "Maria da Silva",
"email": "teste@gmail.com",
"is_pep": false,
"person_type": "natural",
"nationality": "brasileiro(a)",
"marital_status": "single",
"document_identification": "88888-0ddf-4932-874f-9231794963da",
"phone": {
"country_code": "055",
"area_code": "19",
"number": "999999999"
},
"address": {
"street": "Rua dos Limões",
"neighborhood": "Vila Moinho Velho",
"city": "São Paulo",
"state": "SP",
"postal_code": "04286100",
"number": "116",
"complement": "complemento"
}
}
],
"company_type": "ltda"
},
"signed_contract": {
"document_key": "57cda530-d469-4427-a9d4-2523a510dee1",
"signatures": [
{
"authenticity": {
"timestamp": "2024-05-10T14:15:03.114895Z",
"ip_address": "192168161",
"lang": "-35.8916627",
"lat": "-7.2226067",
"session_id": "54b8e3cf-15de-41e5-9305-0ecf059d6e2a",
"facial_recognition_key": "c367a540-2e7e-4373-a167-61bc43c30dc1"
},
"signer": {
"name": "Nome do assinante",
"email": "teste@gmail.com.br",
"phone": {
"country_code": "55",
"area_code": "11",
"number": "999999999"
},
"document_number": "99999999"
},
"authentication_type": "opt-in"
}
]
},
"additional_documents": [
"61f2a65e-0ddf-4932-874f-9231794963da"
]
}
Request Body Params
Field | Type | Description | Characters |
---|---|---|---|
account_owner * | object | Account Holder Object | Account Owner Object |
signed_contract * | object | Object containing the information of the electronic acceptance of the account opening terms. | Signed Contract Object |
additional_documents * | list | List with the DOCUMENT_KEY (uuidv4) of the account holder's additional documents. | 36 |
Objeto account_owner
Field | Type | Description | Characters |
---|---|---|---|
address * | object | Address Object of the account holder | Address Object |
cnae_code * | string | National Classification of Economic Activities | 9 |
company_document_number * | string | Brazilian company's identification number (CNPJ) | 14 |
company_statute * | string | DOCUMENT_KEY of the company's statute (DOCUMENT_KEY is returned in the response of the Upload of documents endpoint) | 36 |
company_type | enum | Type of the company | Enum company_type |
company_representatives * | list | List of the company's legal representatives | Company Representatives Object |
email * | string | Institutional e-mail of the company. | 254 |
foundation_date * | string | Company foundation date (format "YYYY-MM-DD"). | 10 |
name * | string | Corporate name. | 100 |
person_type * | enum | Identifier that the object sent is a legal entity. Should ALWAYS contain the value "legal". | Enum person_type |
phone * | object | Phone of the account holder. | Phone Object |
trading_name * | string | Trade name. | 200 |
Objeto company_representatives
Field | Type | Description | Characters |
---|---|---|---|
name * | string | Name of the company representative | 100 |
address * | object | Address Object of the company representative | Address Object |
email * | string | Email of the company representative | 254 |
birth_date * | string | Birth date of the company representative (format "YYYY-MM-DD") | 10 |
individual_document_number * | string | CPF of the company representative (only numbers) | 11 |
document_identification | string | DOCUMENT_KEY of the identification document PDF with a photo (ID or Driver's License) (previously submitted) | 36 |
document_identification_number | string | Identification document number with a photo of the person (ID or Driver's License) | 16 |
document_identification_type | enum | Type of identification document with a photo of the person (ID or Driver's License) | Enum document_identification_type |
is_pep * | boolean | Declaration if the person is PEP (Politically Exposed Person) (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | - |
marital_status | enum | Marital status of the company representative | Enum marital_status |
mother_name * | string | Mother's name of the company representative | 100 |
nationality | string | Nationality of the company representative | 50 |
person_type * | enum | Identifier indicating that the object sent is an individual | Enum person_type |
phone * | object | Object with phone data of the company representative | Phone Object |
Objeto address
Field | Description | Example | Characters |
---|---|---|---|
street * | Street of the address | Rua do endereço | 500 |
state * | State of the address (with two uppercase characters) | Estado do endereço (com dois caracteres maiúsculos) | 2 |
city * | City of the address | Cidade do endereço | 255 |
neighborhood * | Neighborhood of the address | Bairro do endereço | 500 |
number * | Street number | Número da rua | 10 |
postal_code * | Postal code of the address (http://www.buscacep.correios.com.br/sistemas/buscacep/) (only numbers) | CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números) | 8 |
complement | Additional address information (free text) | Complemento do endereço (texto livre) | 500 |
Objeto signed_contract
Field | Type | Description | Characters |
---|---|---|---|
document_key * | uuidv4 | Unique key for identifying the document of the Account Opening Term or Escrow Account Contract. (The DOCUMENT_KEY is returned in the response of the Upload of documents endpoint) | 36 |
signatures * | list | Signature data of the submitted document. Each item in the list corresponds to a signer of the document. | Signatures Object |
Objeto signatures
Field | Type | Description | Characters |
---|---|---|---|
authenticity * | object | Set of data that provides evidence of the electronic signature performed by the signer. | Authenticity Object |
signer * | object | Object containing the data of one of the document signers. | Signer Object |
authentication_type * | enumerator | Type of signature. It will always be "opt-in" | "opt-in" |
Objeto authenticity
Field | Type | Description | Characters |
---|---|---|---|
timestamp * | string | Date and time of the document signing moment. | 27 |
facial_recognition_key | uuidv4 | Unique key for identifying the account holder's selfie photo. (The DOCUMENT_KEY is returned in the response of the Upload of documents 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 | Signer's session ID at the time of signing. | - |
Objeto signer
Field | Type | Description | Characters |
---|---|---|---|
name * | string | Name of the signer. | - |
email * | string | Email of the signer. | - |
phone * | object | Object containing the signer's phone data | Phone Object |
document_number * | string | CPF of the signer. | 11 |
Objeto phone
Field | Type | Description | Characters |
---|---|---|---|
country_code * | string | Phone country code (https://ddi.guiamais.com.br/) | 3 |
area_code * | string | Phone area code (https://ddd.guiamais.com.br/) | 2 |
number * | string | Phone number (only numbers) | 10 |
Enumerators person_type
Enum | Description |
---|---|
natural | Natural person |
legal | Legal entity |
Enumerators document_identification_type
Enum | Description |
---|---|
rg | RG - General Registry |
cnh | CNH - National Driver's License |
Enumeradores company_type
Enum | Description |
---|---|
ltda | Limited |
sa | Corporation |
micro_enterprise | Micro Enterprise |
freelancer | Freelancer |
sa_opened | Publicly Held Corporation |
sa_closed | Privately Held Corporation |
se_ltda | Limited Liability Company |
se_cn | General Partnership |
se_cs | Simple Command Partnership |
se_ca | Joint-stock Partnership |
scp | Silent Partnership |
ei | Sole Proprietor |
ese | Establishment, in Brazil, of a Foreign Company |
eeab | Establishment, in Brazil, of a Binational Argentine-Brazilian Company |
ssp | Pure Simple Society |
ss_ltda | Simple Limited Company |
ss_cn | Simple General Partnership |
ss_cs | Simple Command Partnership |
eireli_ne | Single Member Limited Liability Company (Business Nature) |
eireli_ns | Single Member Limited Liability Company (Simple Nature) |
eireli | Individual Responsibility Company |
mei | Individual Micro Entrepreneur |
me | Micro Enterprise |
cop | Cooperative |
private_association | Private Society |
Enumeradores marital_status
Enum | Description |
---|---|
single | Single |
married | Married |
widower | Widowed |
divorced | Divorced |
separated | Separated |
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 | Account Info Object |
account_request_key * | string | Key for identifying the account creation request | - |
account_request_status * | string | KYC Status | - |
Account Info Object
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 |