Confirm Individual 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 account reservation request.	36

Escrow account opening

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",
        "monthly_income": 1000
    },
    "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"
            }
        ]
    },
    "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 the Account Holder information	account_owner Object
signed_contract *	object	Object containing the 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	Address of the account holder.	address Object
birth_date *	string	Birth date of the account holder (format "YYYY-MM-DD").	-
document_identification *	uuidv4	DOCUMENT_KEY of the PDF of the account holder's identification document with photo (ID or Driver's License) (previously uploaded)	36
email *	string	Email of the account holder.	200
individual_document_number	string	CPF of the account holder (numbers only). Limited to 11 characters.	11
is_pep *	string	Declaration if the person is a PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).	-
mother_name *	string	Mother's name of the client in case of individual.	-
name *	string	Name of the account holder.	-
nationality *	string	Nationality of the client.	-
person_type *	enumerator	Identifier that the sent object is an individual or legal entity.	person_type Enumerators
phone *	string	Object with phone data	phone Object
proof_of_residence	string	DOCUMENT_KEY of the PDF of the address proof for the sent address (previously uploaded).	-
monthly_income*	number	Monthly income of the account holder

address Object

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

Field	Type	Description	Characters
street *	string	Street of the address	500
state *	string	State of the address (with two uppercase characters)	2
city *	string	City of the address	255
neighborhood *	string	Neighborhood of the address	500
number *	string	Street number	10
postal_code *	string	Postal code of the address (http://www.buscacep.correios.com.br/sistemas/buscacep/) (numbers only)	8
complement *	string	Address complement (free text)	500

destinations Object

Field	Type	Description	Characters
account_branch *	string	Branch number of the destination account.	4
account_number *	string	Destination account number.	-
account_digit *	string	Check digit of the destination account number.	1
document_number *	string	CPF/CNPJ of the destination account holder.	-
name	string	Name/Corporate Name of the destination account holder.	-
ispb_number *	string	ISPB (CNPJ base) of the destination account's financial institution.	8
financial_institution_code_number *	string	Code of the destination account's financial institution.	3

signed_contract Object

Field	Type	Description	Characters
document_key *	uuidv4	Unique identification key of the Account Opening Agreement 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 sent 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 evidences 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	Signature type. Will always be "opt-in"	"opt-in"

person_type Enumerators

Enum	Description
natural *	Individual
legal *	Legal Entity

authenticity Object

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.	36
lang	string	Longitude coordinate of the signer's geolocation captured at the time of signature.	-
lat	string	Latitude coordinate of the signer's geolocation captured at the time of signature.	-
ip_address	string	IP address of the signer's device.	-
session_id *	string	Session ID of the signer at the time of signature.	-

signer Object

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

phone Object

Field	Description	Example	Max. Characters
country_code *	string	Country code of the phone (https://ddi.guiamais.com.br/)	3
area_code *	string	Area code of the phone (https://ddd.guiamais.com.br/)	3
number *	string	Phone number (numbers only)	10

Response

STATUS

201

Response Body

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

Attention

The account_key field will be the unique identification key of the account. All interaction with the account will be done 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