Confirm Legal Entity Account Opening

Account opening occurs in two mandatory steps. First, a POST request sends preliminary data to reserve the account. Then, a webhook of type account_request.status_change with status pending_additional_data is triggered. In the second step, a PATCH request finalizes the opening, officially creating the account with the complementary information.

Request

ENDPOINT

/account_request/ACCOUNT_REQUEST_KEY/escrow

METHOD

PATCH

Path Params

Field	Type	Description	Characters
account_request_key	uuidv4	Unique identification key for the account reservation request.	36

Escrow Account Opening

Request Body

{
    "account_owner": {
        "address": {
            "city": "Caraguatatuba",
            "complement": "complemento",
            "neighborhood": "Jaraguazinho",
            "number": "924",
            "postal_code": "11675200",
            "state": "SP",
            "street": "Praça Jorge Vitório de Souza"
        },
        "cnae_code": "4721-1/02",
        "company_document_number": "64669455000187",
        "company_statute": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
        "company_type": "ltda",
        "email": "marcos.alves@yopmail.com",
        "foundation_date": "2017-09-16",
        "name": "NOME DA EMPRESA",
        "person_type": "legal",
        "phone": {
            "area_code": "19",
            "country_code": "055",
            "number": "988888888"
        },
        "trading_name": "Pães e Doces",
        "monthly_revenue": 100000,
        "company_representatives": [
            {
                "name": "Marcos Felipe Henrique Alves",
                "address": {
                    "city": "Recife",
                    "complement": null,
                    "neighborhood": "Fundão",
                    "number": "137",
                    "postal_code": "52221110",
                    "state": "PE",
                    "street": "Rua Camapuã"
                },
                "email": "marcos.alves@yopmail.com",
                "birth_date": "1972-02-02",
                "individual_document_number": "08531309069",
                "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
                "document_identification_number": "339122924",
                "is_pep": false,
                "marital_status": "single",
                "mother_name": "Sueli Isadora Alves",
                "nationality": "Brasileira",
                "person_type": "natural",
                "phone": {
                    "area_code": "88",
                    "country_code": "055",
                    "number": "995924634"
                }
            }
        ]
    },
    "signed_contract": {
        "document_key": "4d7f4e29-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": "IVANILDO DE SENA LIMA",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "destinations": [
        {
            "account_branch": "0001",
            "account_number": "1234567",
            "account_digit": "1",
            "document_number": "04252012000123",
            "name": "Conta do FIDC",
            "ispb_number": "32402502",
            "financial_institution_code_number": "329"
        }
    ],
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Request Body Params

Field	Type	Description	Characters
account_owner *	object	Object containing Account Holder information	account_owner Object
signed_contract *	object	Object containing Account Holder information	signed_contract Object
destinations *	list	List of destination accounts authorized to receive transfers.	destinations Object
additional_documents	list	List of additional/optional document IDs.	Array of UUIDs

account_owner Object

Field	Type	Description	Characters
address *	object	Account holder address.	address Object
cnae_code *	string	National Classification of Economic Activities	9
company_document_number *	string	CNPJ	14
company_statute	uuidv4	DOCUMENT_KEY of the company statute PDF (previously uploaded).	36
company_type *	enumerator	Company type	company_type Enumerators
email *	string	Account holder email.	200
foundation_date *	string	Company founding date (format "YYYY-MM-DD").	10
name *	string	Account holder company name.	50
person_type *	enumerator	Identifier indicating whether the submitted object is a natural person or legal entity.	person_type Enumerators
phone *	object	Object with phone data	phone Object
trading_name *	string	Trade name.	200
company_representatives	list	List of the company's legal representatives	company_representatives Object
monthly_revenue*	number	Company monthly revenue

signed_contract Object

Field	Type	Description	Characters
document_key *	uuidv4	Unique identification key for the Account Opening Agreement or Escrow Account Contract document. (The DOCUMENT_KEY is returned in the response from the Document upload endpoint)	36
signatures *	list	Signature data for the submitted document. Each item in the list corresponds to a document signer.	signatures Object

destinations Object

Field	Type	Description	Characters
account_branch *	string	Destination account branch number.	4
account_number *	string	Destination account number.	-
account_digit *	string	Destination account number check digit.	1
document_number *	string	CPF/CNPJ of the destination account holder.	-
name	string	Name/Company Name of the destination account holder.	-
ispb_number *	string	ISPB (CNPJ base) of the destination account financial institution.	8
financial_institution_code_number *	string	Destination account financial institution code.	3

company_representatives Object

Field	Type	Description	Characters
name *	string	Company representative name	100
address *	object	Company representative address object	address Object
email *	string	Company representative email	254
birth_date *	string	Company representative birth date (format "YYYY-MM-DD")	10
individual_document_number *	string	Company representative CPF (numbers only).	11
document_identification	string	DOCUMENT_KEY of the person's photo identification document PDF (ID or Driver's License) (previously uploaded)	36
document_identification_number	string	Person's photo identification document number (ID or Driver's License)	16
document_identification_type	enum	Person's photo identification document type (ID or Driver's License)	document_identification_type Enumerators
is_pep *	boolean	Declaration whether the person is PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).	-
marital_status	enum	Company representative marital status	marital_status Enumerators
mother_name *	string	Company representative mother's name	100
nationality	string	Company representative nationality	50
person_type *	enum	Identifier indicating that the submitted object is a natural person	person_type Enumerators
phone *	object	Object with company representative phone data	phone Object

address Object

This object, present in both natural person and legal entity objects, is a simple object to represent an address.

Field	Description	Example	Characters
street *	string	Address street	500
state *	enum	Address state (with two uppercase characters)	2
city *	string	Address city	255
neighborhood *	string	Address neighborhood	500
number *	string	Street number	10
postal_code *	string	Address ZIP code (http://www.buscacep.correios.com.br/sistemas/buscacep/) (numbers only)	8
complement	string	Address complement (free text)	500

signed_contract Object

Field	Type	Description	Characters
document_key *	uuidv4	Unique identification key for the Account Opening Agreement or Escrow Account Contract document. (The DOCUMENT_KEY is returned in the response from the Document upload endpoint)	36
signatures *	list	Signature data for the submitted document. Each item in the list corresponds to a document signer.	signatures Object

signatures Object

Field	Type	Description	Characters
authenticity *	object	Set of data that evidence the electronic signature performed by the signer.	authenticity Object
signer *	object	Object containing data of one of the document signers.	signer Object
authentication_type *	enumerator	Signature type. Will always be "opt-in"	"opt-in"

authenticity Object

Field	Type	Description	Characters
timestamp *	string	Date and time of the document signing moment.	27
facial_recognition_key *	uuidv4	Unique identification key for the account holder's selfie photo.	36
lang	string	Longitude coordinate of the signer's geolocation captured at the signing moment.	-
lat	string	Latitude coordinate of the signer's geolocation captured at the signing moment.	-
ip_address	string	Signer's device IP address.	-
session_id *	string	Signer's session ID at the signing moment.	-

signer Object

Field	Type	Description	Characters
name *	string	Signer name.	-
email *	string	Signer email.	-
phone *	object	Object with signer phone data	phone Object
document_number *	string	Signer CPF.	11

phone Object

Field	Description	Example	Max 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 (numbers only)	10

person_type Enumerators

Enum	Description
natural	Natural person
legal	Legal entity

document_identification_type Enumerators

Enum	Description
rg	RG - General Registry
cnh	CNH - National Driver's License

company_type Enumerators

Enum	Description
ltda	Limited Liability Company
sa	Corporation
micro_enterprise	Micro Enterprise
freelancer	Freelancer
sa_opened	Publicly Traded Corporation
sa_closed	Privately Held Corporation
se_ltda	Limited Business Partnership
se_cn	General Partnership
se_cs	Limited Partnership
se_ca	Partnership Limited by Shares
scp	Silent Partnership
ei	Individual Entrepreneur
ese	Branch Office in Brazil of Foreign Company
eeab	Branch Office in Brazil of Argentine-Brazilian Binational Company
ssp	Simple Partnership
ss_ltda	Limited Simple Partnership
ss_cn	Simple General Partnership
ss_cs	Simple Limited Partnership
eireli_ne	Individual Limited Liability Company (Business Nature)
eireli_ns	Individual Limited Liability Company (Simple Nature)
eireli	Individual Limited Liability Company
mei	Individual Microentrepreneur
me	Micro Enterprise
cop	Cooperative
private_association	Private Association
association	Association
others	Others

marital_status Enumerators

Enum	Description
single	Single
married	Married
widower	Widowed
divorced	Divorced
separated	Separated

Response

STATUS

201

Response Body

{
    "account_key": "e48eb139-448e-43b9-9aee-df5f4b51158c"
}

Attention

The account_key will be the account's unique identification key. All account interactions will be performed through it.

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description(ptbr) translation
400	QIT000001	Bad Request	Schema Error	Schema Error
404	QIT000404	Not Found	Resource could not be found	Resource not found