Confirmar Abertura de Conta de Pessoa Jurídica
A abertura de conta ocorre em duas etapas obrigatórias. Primeiro, uma requisição POST envia dados preliminares para reservar a conta. Em seguida, um webhook do tipo account_request.status_change
com o status pending_additional_data
é disparado. Na segunda etapa, uma requisição PATCH finaliza a abertura, oficializando a conta com as informações complementares.
Request
ENDPOINT
/account_request/ACCOUNT_REQUEST_KEY/escrowMÉTODO
PATCHPath Params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_request_key | uuidv4 | Chave única de identificação solicitação de reserva da conta. | 36 |
Abertura de conta Escrow
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",
"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
Campo | Tipo | Descrição | Caractéres |
---|---|---|---|
account_owner * | object | Objeto contendo as informações do Titular da Conta | Objeto account_owner |
signed_contract * | object | Objeto contendo as informações do Titular da Conta | Objeto signed_contract |
destinations * | list | Lista de contas destino autorizadas a receber transaferências. | Objeto destinations |
additional_documents * | list | Lista de id's de documentos extras/opcionais . | Array de UUID's |
Objeto account_owner
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
address * | object | Endereço do titular da conta. | Objeto adress |
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 | ##criar enummm |
email * | string | Email do titular da conta. | 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 física ou jurídica. | Enumeradores person_type |
phone * | object | Objeto com dados do telefone | Objeto phone |
trading_name * | string | Nome fantasia. | 200 |
company_representatives | list | Lista dos representantes legais da empresa | Objeto company_representatives |
Objeto signed_contract
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 |
Objeto 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 |
Objeto company_representatives
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
name * | string | Nome do representante da empresa | 100 |
address * | object | Objeto endereço do representante da empresa | Objeto 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 | string | 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 | Objeto phone |
Objeto address
Este objeto, presente tanto no objeto PF quanto no objeto PJ, é um simples objeto para representar um endereço.
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 |
Objeto signed_contract
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 |
Objeto 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" |
Objeto 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. | - |
Objeto 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 | Objeto phone |
document_number * | string | CPF do assinante. | 11 |
Objeto phone
Campo | Descrição | Exemplo | Máx. 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/) | 2 |
number * | string | Número de telefone (apenas números) | 10 |
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) |
Response
STATUS
201Response Body
{
"account_key": "e48eb139-448e-43b9-9aee-df5f4b51158c"
}
Atenção
A account_key
será a chave única de identificação da conta. Toda interação com a conta se dará através dela.
STATUS
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Código HTTPstatus | Código QIcode | Títulotitle | Descrição (eng)description | Descrição(ptbr) translation |
---|---|---|---|---|
400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
404 | QIT000404 | Not Found | Resource could not be found | Recurso não encontrado |