Abertura de Conta em Duas Etapas

Solicitar Reserva de Conta de Livre Movimentação

Request

ENDPOINT

/account_request/checking

METHOD

POST

Request Body - Titular PJ

{
    "account_owner": {
        "company_document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "foundation_date": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

Request Body - Titular PF

{
    "account_owner": {
        "document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "birthdate": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

Solicitar Reserva de Conta Escrow

ENDPOINT

/account_request/escrow

METHOD

POST

Request Body - Titular PJ

{
    "account_owner": {
        "company_document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "foundation_date": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

Request Body - Titular PF

{
    "account_owner": {
        "document_number": "64669455000187",
        "email": "marcos.alves@yopmail.com",
        "birthdate": "2017-09-16",
        "name": "NOME DA EMPRESA"
    }
}

Body Params Titular PJ

Campo	Tipo	Descrição	Caracteres
account_owner	object	Informações simplificadas da pessoa jurídica titular da conta	Objeto account_owner PJ Objeto account_owner PF

Object account_owner Solicitar Reserva PJ

Campo	Tipo	Descrição	Caracteres
company_document_number *	string	CNPJ do titualar da conta.	14
email *	string	E-mail da empresa titular da contato.	200
foundation_date	string	Data de abertura da empresa.	10
name *	string	Razão Social da empresa titular da conta.	50

Object account_owner Solicitar Reserva PF

Campo	Tipo	Descrição	Caracteres
document_number *	string	CPF do titualar da conta.	14
email *	string	E-mail da empresa titular da contato.	200
birthdate	string	Data de nascimento.	10
name *	string	Razão Social da empresa titular da conta.	50

Response

STATUS

201

Response Body

{
    "account_info": {
        "account_branch": "0001",
        "account_digit": "3",
        "account_number": "1638634"
    },
    "account_request_key": "e48eb139-448e-43b9-9aee-df5f4b51158c",
    "account_request_status": "pending_kyc_analysis"
}

Webhook aprovação KYC

Webhook Body

{
    "data": {
        "account_info": {
            "account_digit": "3",
            "account_branch": "0001",
            "account_number": "1638634"
        },
        "account_request_key": "dc575950-dcce-48e1-99a6-5fb0ada63d86"
    },
    "event_datetime": "2022-09-02 22:39:39",
    "key": "dc575950-dcce-48e1-99a6-5fb0ada63d86",
    "status": "pending_additional_data",
    "webhook_type": "account_request.status_change"
}

Enumeradores account_request_status

Enum	Description
pending_kyc_analysis	Pendente aprovação KYC
pending_additional_data	Pendente informações adicionais
rejected	Abertura rejeitada

Abertura de Conta Livre Movimentação

Request

ENDPOINT

/account_request/ACCOUNT_REQUEST_KEY/checking

METHOD

PATCH

Request Body - Titular PJ

{
    "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",
        "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"
            }
        ]
    },
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Request Body - Titular PF

{
    "account_owner": {
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "birth_date": "1990-05-06",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "email": "ivanlima2604@gmail.com",
        "individual_document_number": "34651104630",
        "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": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
    "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": "Nome do Titular da Conta",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Response

STATUS

201

Response Body

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

ACCOUNT_KEY

A account_key será a chave única de identificação da conta. Toda interação com a conta se dará através dela.

Abertura de Conta Escrow

Request

ENDPOINT

/account_request/ACCOUNT_REQUEST_KEY/escrow

METHOD

PATCH

Request Body - Titular PJ

{
    "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",
        "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 - Titular PF

{
    "account_owner": {
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "birth_date": "1990-05-06",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "email": "ivanlima2604@gmail.com",
        "individual_document_number": "34651104630",
        "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": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
    "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": "Nome do Titular da Conta",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "34651104630"
                },
                "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"]
}

Response

STATUS

201

Response Body

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

ACCOUNT_KEY

A account_key será a chave única de identificação da conta. Toda interação com a conta se dará através dela.

Body Params Abertura de Conta

Campo	Tipo	Descrição	Caracteres
account_owner *	object	Informações completas do titular da conta	Object account_owner PJ Object account_owner PF
signed_contract *	object	Objeto contendo os dados de contrato e dos assinantes do contrato da conta.	Object signed_contract
destinations **	list	Lista de contas destino autorizadas a receber transaferências.	Object destinations
additional_documents	list	Lista de id's de documentos extras/opcionais .	Array de UUID's

(**) Obrigatório para conta Escrow

Object account_owner Abertura de Conta PJ

Campo	Tipo	Descrição	Caracteres
address *	object	Objeto endereço do titular da conta	Object address
cnae_code *	string	Classificação Nacional de Atividades Econômicas	9
company_document_number *	string	CNPJ	14
company_statute *	uuidv4	DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente).	36
company_type *	enumerator	Tipo da empresa	Enumeradores company_type
email *	string	Email institucional da empresa.	200
foundation_date *	string	Data de abertura da empresa (formato "AAAA-MM-DD").	10
name *	string	Razão social do titular da conta.	50
person_type *	enumerator	Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ.	Enumeradores person_type
phone *	object	Telefone do titular da conta.	Object phone
trading_name *	string	Nome fantasia.	200
company_representatives *	list	Lista dos representantes legais da empresa	Object company_representatives

Object account_owner Abertura de Conta PF

Campo	Tipo	Descrição	Caracteres
address	string	Objeto endereço do titular da conta	Object address
birth_date *	string	Data de nascimento da pessoa (formato "AAAA-MM-DD")	-
document_identification *	uuidv4	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)	36
email *	string	Email do titular da conta.	200
individual_document_number *	string	CPF da pessoa (apenas números).	11
is_pep *	boolean	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).	-
mother_name *	string	Nome da mãe do titular da conta.	-
name *	string	Nome do titular da conta.	-
nationality *	string	Nacionalidade do cliente.	-
person_type *	string	Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "natural" para Objeto PF.	Enumeradores person_type
phone	string	Objeto com dados do telefone do titular da conta	36
proof_of_residence	uuidv4	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente).

Object address

Campo	Descrição	Exemplo	Caracteres
street *	string	Rua do endereço	500
state *	enum	Estado do endereço (com dois caracteres maiúsculos)	2
city *	string	Cidade do endereço	255
neighborhood *	string	Bairro do endereço	500
number *	string	Número da rua	10
postal_code *	string	CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)	8
complement	string	Complemento do endereço (texto livre)	500

Object phone

Campo	Descrição	Exemplo	Caracteres
country_code *	string	Código DDI do telefone (https://ddi.guiamais.com.br/)	3
area_code *	string	Código DDD do telefone (https://ddd.guiamais.com.br/)	3
number *	string	Número de telefone (apenas números)	10

Object company_representatives

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do representante da empresa	100
address *	object	Objeto endereço do representante da empresa	Object address
email *	string	Email do representante da empresa	254
birth_date *	string	Data de nascimento representante da empresa (formato "AAAA-MM-DD")	10
individual_document_number *	string	CPF do representante da empresa (apenas números).	11
document_identification *	uuidv4	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)	36
document_identification_number	string	Número do documento de identificação com foto da pessoa (RG ou CNH)	16
document_identification_type	enum	Tipo do documento de identificação com foto da pessoa (RG ou CNH)	Enumeradores document_identification_type
is_pep *	boolean	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).	-
marital_status	enum	Estado civil do representante da empresa	Enumeradores marital status
mother_name *	string	Nome da mãe do representante da empresa	100
nationality	string	Nacionalidade do representante da empresa	50
person_type *	enum	Identificador de que o objeto enviado é uma pessoa física	Enumeradores person_type
phone *	object	Objeto com dados do telefone do representante da empresa	Object phone

Object signed_contract conta livre

Campo	Tipo	Descrição	Caracteres
document_key *	uuidv4	Chave única de identificação do documento do Termo de Abertura de Conta ou Contrato de Conta Escrow. (A DOCUMENT_KEY é retornada na resposta do endpoint de Upload de documentos)	36
signatures *	list	Dados de assinatura do documento enviado. Cada item da lista, corresponde a um assinante do documento.	Objeto signatures

Object signatures

Campo	Tipo	Descrição	Caracteres
authenticity *	object	Conjunto de dados que evidenciam a assinatura eletrônica realizada pelo assinante.	Objeto authenticity
signer *	object	Objeto contendo os dados de um dos assinantes do documento.	Objeto signer
authentication_type *	enumerator	Tipo de assinatura. Sempre será "opt-in"	"opt-in"

Object authenticity

Campo	Tipo	Descrição	Caracteres
timestamp *	string	Data e hora do momento da assinatura do documento.	27
facial_recognition_key	uuidv4	Chave única de identificação da foto da selfie do titular da conta. (A DOCUMENT_KEY é retornada na resposta do endpoint de Upload de documentos)	36
lang	string	Coordenada de longitude da geolocalização do assinante capturada no momento da assinatura.	-
lat	string	Coordenada de latitude da geolocalização do assinante capturada no momento da assinatura.	-
ip_address	string	Endereço IP do dispositivo do assinante.	-
session_id	string	ID da seção do assinante no momento da assinatura.	-

Object signer

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do assinante.	-
email *	string	Email do assinante.	-
phone *	object	Objeto com dados do telefone do assinante	Object phone
document_number *	string	CPF do assinante.	11

Object destinations

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Número da Agência da conta destino.	4
account_number *	string	Número da conta destino.	-
account_digit *	string	Dígito verificador do número da conta destino.	1
document_number *	string	CPF/CNPJ do titular da conta destino.	-
name *	string	Nome/Razão Social do titular da conta destino.	-
ispb_number *	string	ISPB (base do CNPJ) da instituição financeira da conta destino.	8
financial_institution_code_number *	string	Código da instituição financeira da conta destino.	3

Enumeradores person_type

Enum	Description
natural	Pessoa física
legal	Pessoa jurídica

Enumeradores document_identification_type

Enum	Description
rg	RG - Registro Geral
cnh	CNH - Carteira Nacional de Habilitação

Enumeradores company_type

Enum	Description
ltda	Limitada
sa	Sociedade Anônima
micro_enterprise	Micro Empresa
freelancer	Freelancer
sa_opened	Sociedade Anônima de Capital Aberto
sa_closed	Sociedade Anônima de Capital Fechado
se_ltda	Sociedade Empresária Limitada
se_cn	Sociedade Empresária em Nome Coletivo
se_cs	Sociedade Empresária em Comandita Simples
se_ca	Sociedade Empresária em Comandita por Ações
scp	Sociedade em Conta de Participação
ei	Empresário Individual
ese	Estabelecimento, no Brasil, de Sociedade Estrangeira
eeab	Estabelecimento, no Brasil, de Empresa Binacional Argentino-Brasileira
ssp	Sociedade Simples Pura
ss_ltda	Sociedade Simples Limitada
ss_cn	Sociedade Simples em Nome Coletivo
ss_cs	Sociedade Simples em Comandita Simples
eireli_ne	Empresa Individual de Responsabilidade Limitada (de Natureza Empresária)
eireli_ns	Empresa Individual de Responsabilidade Limitada (de Natureza Simples)
eireli	Empresa de Responsabilidade Individual
mei	Micro Empreendedor Individual
me	Micro Empresa
cop	Cooperativa
private_association	Sociedade Privada
association	Associação
others	Outros

Enumeradores marital_status

Enum	Description
single	Solteiro(a)
married	Casado(a)
widower	Viúvo(a)
divorced	Divorciado(a)
separated	Separado(a)

Abertura de Conta em Duas Etapas

Solicitar Reserva de Conta de Livre Movimentação​

Request​

Solicitar Reserva de Conta Escrow​

Body Params Titular PJ​

Object account_owner Solicitar Reserva PJ​

Object account_owner Solicitar Reserva PF​

Response​

Webhook aprovação KYC​

Enumeradores account_request_status​

Abertura de Conta Livre Movimentação​

Request​

Response​

Abertura de Conta Escrow​

Request​

Response​

Body Params Abertura de Conta​

Object account_owner Abertura de Conta PJ​

Object account_owner Abertura de Conta PF​

Object address​

Object phone​

Object company_representatives​

Object signed_contract conta livre​

Object signatures​

Object authenticity​

Object signer​

Object destinations​

Enumeradores person_type​

Enumeradores document_identification_type​

Enumeradores company_type​

Enumeradores marital_status​

Solicitar Reserva de Conta de Livre Movimentação

Request

Solicitar Reserva de Conta Escrow

Body Params Titular PJ

Object account_owner Solicitar Reserva PJ

Object account_owner Solicitar Reserva PF

Response

Webhook aprovação KYC

Enumeradores account_request_status

Abertura de Conta Livre Movimentação

Request

Response

Abertura de Conta Escrow

Request

Response

Body Params Abertura de Conta

Object account_owner Abertura de Conta PJ

Object account_owner Abertura de Conta PF

Object address

Object phone

Object company_representatives

Object signed_contract conta livre

Object signatures

Object authenticity

Object signer

Object destinations

Enumeradores person_type

Enumeradores document_identification_type

Enumeradores company_type

Enumeradores marital_status