Abertura de conta escrow PJ
Request
ENDPOINT
/escrowMÉTODO
POSTRequest Body
{
"account_manager": {
"address": {
"city": "São Paulo",
"complement": "",
"neighborhood": "Vila Madalena",
"number": "40",
"postal_code": "05435030",
"state": "SP",
"street": "Rua das batatas"
},
"cnae_code": "6619-3/99",
"company_document_number": "99999999000188",
"company_representatives": [
{
"address": {
"city": "São Paulo",
"complement": "",
"neighborhood": "Vila Madalena",
"number": "40",
"postal_code": "05435030",
"state": "SP",
"street": "Rua da Alegria"
},
"birth_date": "1982-12-30",
"email": "teste@email.tech",
"individual_document_number": "99999999999",
"is_pep": false,
"mother_name": "Ana Perdigão",
"name": "João Victor",
"nationality": "Brasileira",
"person_type": "natural",
"phone": {
"area_code": "12",
"country_code": "055",
"number": "999999999"
},
"document_identification": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d",
"proof_of_residence": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d"
}
],
"company_statute": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d",
"directors_election_minute": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d",
"email": "email@teste.tech",
"foundation_date": "2021-10-05",
"name": "TESTE TECH LTDA.",
"person_type": "legal",
"phone": {
"area_code": "11",
"country_code": "55",
"number": "999999999"
},
"trading_name": "TESTE TECH LTDA."
},
"account_owner": {
"address": {
"city": "Caraguatatuba",
"complement": "complemento",
"neighborhood": "Jaraguazinho",
"number": "924",
"postal_code": "11675200",
"state": "SP",
"street": "Praça da Rua"
},
"cnae_code": "4721-1/02",
"company_statute": "70448962-8f01-4835-b031-755514192641",
"company_document_number": "49999999000130",
"company_type": "ltda",
"email": "email@yteste.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": "Marco Ayo",
"address": {
"city": "Recife",
"complement": null,
"neighborhood": "Fundão",
"number": "137",
"postal_code": "522222220",
"state": "PE",
"street": "Rua dos Camaroes"
},
"email": "marcos.teste@teste.com",
"birth_date": "1972-02-02",
"individual_document_number": "55555555555",
"document_identification": "70448962-8454-4835-b031-755514192641",
"document_identification_number": "999999999",
"is_pep": false,
"marital_status": "single",
"mother_name": "Sueli da Mata",
"nationality": "Brasileira",
"person_type": "natural",
"phone": {
"area_code": "88",
"country_code": "055",
"number": "999999999"
}
}
]
},
"destination_list": [
{
"account_branch": "0001",
"account_digit": "2",
"account_number": "123321",
"document_number": "99999999999",
"financial_institutions_code_number": "341",
"name": "Conta Destino Teste SA."
}
],
"allowed_user": {
"email": "teste@email.com",
"individual_document_number": "99999999999",
"name": "Luiz Alberto ",
"person_type": "natural",
"phone": {
"country_code": "055",
"area_code": "12",
"number": "999999999"
}
},
"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.000",
"session_id": "jdifj329842"
},
"signer": {
"name": "IVANILDO DE SENA LIMA",
"email": "teste@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "99999999999"
},
"authentication_type": "opt-in"
}
]
}
}
BODY PARAMS
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
account_manager * | object | Objeto que possui pessoa responsável pelas movimentações da conta. | Objeto adress |
account_owner * | object | Objeto Dono da conta. | Objeto account_owner |
allowed_user * | object | Objeto que possui pessoa que terá acesso à conta para consultas. | Objeto allowed_user |
destination_list * | object | Lista de contas de destino, que são aquelas para onde é permitida a transferência de recursos. | Objeto destination_list |
signed_contract * | object | Objeto contento as informações da assinatura do contrato. | Objeto signed_contract |
Objeto account_manager
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
address * | object | Endereço do cliente. | Objeto address |
cnae_code * | string | Classificação Nacional de Atividades Econômicas | 14 |
company_document_number | object | CNPJ | 14 |
company_statute * | string | DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente). | chave uuid |
directors_election_minute * | string | DOCUMENT_KEY do PDF da Ata de Representantes Legais da empresa (enviado previamente). | chave uuid |
email * | string | Email institucional da empresa. | |
foundation_date * | date | Data de abertura da empresa (formato "AAAA-MM-DD"). | |
name * | string | Razão social. | |
person_type * | string | Identificador de que o objeto enviado é uma pessoa jurídica. Deve conter SEMPRE o valor "legal" para Objeto PJ. | |
phone | string | Objeto com dados do telefone | Objeto phone |
trading_name * | string | Nome fantasia da empresa |
Objeto company_representatives
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
person_type * | string | Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para Objeto PF. | 11 |
name * | string | Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. Limitado a 100 caracteres. | 11 |
mother_name * | string | Nome da mãe da pessoa. | 11 |
birth_date * | string | Data de nascimento da pessoa (formato "AAAA-MM-DD") | 11 |
nationality * | string | Nacionalidade do cliente. Limitado a 50 caracteres. | 11 |
is_pep * | string | Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | 11 |
individual_document_number | string | CPF da pessoa (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) | UUUUID |
proof_of_residence * | UUUUID | DOCUMENT_KEY do PDF do comprovante de residência (enviado previamente) | UUUUID |
email * | string | Email da pessoa. | 11 |
address | string | Objeto endereço da pessoa. | 11 |
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 | Máx. Caracteres |
|---|---|---|---|
street * | string | Rua do endereço | 10 |
state * | string | Estado do endereço (com dois caracteres maiúsculos) | 2 |
city * | string | Cidade do endereço | 10 |
neighborhood * | string | Bairro do endereço | 10 |
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) | 100 |
Objeto account_owner
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
address* | object | Objeto endereço do titular da conta | Objeto address |
cnae_code * | string | Classificação Nacional de Atividades Econômicas | 9 |
company_document_number * | string | CNPJ | 14 |
company_statute * | string | DOCUMENT_KEY do PDF do estatuto da empresa (enviado previamente). | 36 |
company_type | enum | Tipo da empresa | Enumeradores company_type |
company_representatives * | list | Lista dos representantes legais da empresa | Objeto company_representatives |
email * | string | Email institucional da empresa. | 254 |
foundation_date * | string | Data de abertura da empresa (formato "AAAA-MM-DD"). | 10 |
name * | string | Razão social. | 100 |
person_type * | enum | 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. | Objeto phone |
trading_name * | string | Nome fantasia. | 200 |
Objeto allowed_user
| Campo | Descrição | Exemplo | Máx. Caracteres |
|---|---|---|---|
email * | string | Email do usuário da conta. | 10 |
individual_document_number * | string | CPF do usuário da conta (apenas números). | 10 |
name * | string | Nome do usuário da conta. | 10 |
person_type * | string | Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural". | 10 |
phone | string | Objeto telefone do usuário. | Objeto phone |
Objeto destination_list
| Campo | Descrição | Exemplo | Máx. Caracteres |
|---|---|---|---|
account_branch * | string | Número da agência. | 3 |
account_digit * | string | Dígito verificador da conta (obrigatório caso haja). | 3 |
account_number * | string | Número da conta. | 3 |
document_number * | string | CPF ou CNPJ da pessoa (apenas números). | 3 |
financial_institutions_code_number * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 |
name * | string | Nome da pessoa física ou razão social da pessoa jurídica. | |
ted_account_type * | enum | Tipo da conta de destino. | Enumeradores |
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 |
Response
STATUS
200Response Body
{
"data": {
"account_info": {
"account_branch": "0001",
"account_digit": "3",
"account_number": "66777",
"financial_institution_code": "329"
},
"account_manager": {
"company_representatives": [
{
"document_number": "08141163701",
"name": "Aurora Simone Catarina Nogueira"
}
],
"document_number": "09456933000162",
"name": "Kaique e Giovanna Contábil ME"
},
"account_owner": {
"company_representatives": [
{
"document_number": "38689533370",
"name": "Priscila Rayssa Barros"
},
{
"document_number": "85324558400",
"name": "Caio Bruno Dias"
}
],
"document_number": "98916615000167",
"name": "Alice e Isis Advocacia ME"
},
"allowed_transfer_account_list": [
{
"account_branch": "0001",
"account_digit": "2",
"account_number": "532312",
"document_number": "49067117153",
"financial_institution": {
"code": 341,
"ispb": 60701190,
"name": "Itaú Unibanco S.A."
},
"name": "Juan Anthony Farias"
},
{
"account_branch": "0002",
"account_digit": "9",
"account_number": "537612",
"document_number": "39063217000123",
"financial_institution": {
"code": 33,
"ispb": 90400888,
"name": "Banco Santander (Brasil) S. A."
},
"name": "Farias Advogados"
}
],
"allowed_user": {
"document_number": "13708610440",
"name": "Renato Noah Pinto"
}
},
"event_datetime": "2019-11-07 18:15:07",
"key": "61341599-790b-4236-b42f-060634eba88f",
"status": "waiting_administrator_approval",
"webhook_type": "escrow"
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}