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, officializing the account with complementary information.

Request

ENDPOINT

/account_request/ACCOUNT_REQUEST_KEY/checking

METHOD

PATCH

Path Params

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

Free Movement Account Opening

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",
        "monthly_revenue": 100000,
        "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"
                },
                "representative_relationship": "ceo"
            }
        ],
        "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 information about electronic acceptance of account opening terms.	signed_contract Object
`additional_documents` *	list	List with `document_key` (uuidv4) of additional documents from the account holder.	36

account_owner Object

Field	Type	Description	Characters
`address` *	object	Account holder address object	address Object
`cnae_code` *	string	National Classification of Economic Activities	9
`company_document_number` *	string	CNPJ	14
`company_statute` *	string	DOCUMENT_KEY of the company statute PDF (sent previously).	36
`company_type`*	enum	Company type	company_type Enumerators
`company_representatives` *	list	List of company legal representatives	company_representatives Object
`email` *	string	Company institutional email.	254
`foundation_date` *	string	Company establishment date (format "YYYY-MM-DD").	10
`name` *	string	Corporate name.	100
`person_type` *	enum	Identifier that the sent object is a legal entity. Must ALWAYS contain the value "legal" for legal entity object.	person_type Enumerators
`phone` *	object	Account holder phone number.	phone Object
`trading_name` *	string	Trade name.	200
`monthly_revenue`*	number	Company monthly revenue

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 PDF of person's photo identification document (ID or Driver's License) (sent previously)	36
`document_identification_number`*	string	Photo identification document number (ID or Driver's License)	16
`document_identification_type`	enum	Photo identification document type (ID or Driver's License)	document_identification_type Enumerators
`is_pep` *	boolean	Declaration if 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 that the sent object is a natural person	person_type Enumerators
`phone` *	object	Object with company representative phone data	phone Object
`representative_relationship` *	enum	Identifier of the relationship between the company and its representative	**representative_relationship Enumerators

address Object

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

Field	Description	Example	Characters
`street` *	string	Street address	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 postal 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 Terms or Escrow Account Contract document. (The DOCUMENT_KEY is returned in the response of the Document upload endpoint)	36
`signatures` *	list	Signature data for the sent document. Each list item corresponds to a document signatory.	signatures Object

signatures Object

Field	Type	Description	Characters
`authenticity` *	object	Set of data that evidences the electronic signature made by the signatory.	authenticity Object
`signer` *	object	Object containing data of one of the document signatories.	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 document signature moment.	27
`facial_recognition_key`*	uuidv4	Unique identification key for the account holder's selfie photo.	36
`lang`	string	Longitude coordinate of signatory's geolocation captured at signature moment.	-
`lat`	string	Latitude coordinate of signatory's geolocation captured at signature moment.	-
`ip_address`	string	Signatory's device IP address.	-
`session_id`*	string	Signatory's session ID at signature moment.	-

signer Object

Field	Type	Description	Characters
`name` *	string	Signatory name.	-
`email` *	string	Signatory email.	-
`phone` *	object	Object with signatory phone data	phone Object
`document_number` *	string	Signatory 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

representative_relationship Enumerators

Enum	Description
`ceo`	Administrator
`partner`	Partner/Shareholder
`attorney`	Attorney

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`	Closed 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`	Brazilian Establishment of Foreign Company
`eeab`	Brazilian Establishment of Argentine-Brazilian Binational Company
`ssp`	Simple Partnership
`ss_ltda`	Limited Simple Partnership
`ss_cn`	General Simple Partnership
`ss_cs`	Limited Simple 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
`others`	Others

marital_status Enumerators

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

Response

STATUS

201

Response Body

 { "account_key": "78ea0fa6-8ea6-46ff-b66b-d2bc36fc8869" }

Attention

The account_request_key field must be stored and will be used to confirm account opening.

Response Body Params

Field	Type	Description	Characters
`account_key` *	string	Unique account identification key	-

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

Request​

Path Params​

Free Movement Account Opening​

Request Body Params​

account_owner Object​

company_representatives Object​

address Object​

signed_contract Object​

signatures Object​

authenticity Object​

signer Object​

phone Object​

person_type Enumerators​

representative_relationship Enumerators​

document_identification_type Enumerators​

company_type Enumerators​

marital_status Enumerators​

Response​

Response Body Params​