Abertura de conta escrow PF
Request
ENDPOINT
/escrowMÉTODO
POSTRequest Body
{
"account_owner": {
"person_type": "natural",
"name": "Patrícia Tereza Bernardes",
"mother_name": "Maria Mariane",
"birth_date": "1990-05-06",
"nationality": "nationality",
"is_pep": false,
"individual_document_number": "34651104630",
"document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
"email": "api@qitech.com.br",
"address": {
"street": "Av. Brigadeiro Faria Lima",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulistano",
"number": "2391",
"postal_code": "01452905",
"complement": "1º Andar"
},
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
},
"destination_list": [
{
"account_branch": "0001",
"account_digit": "4",
"account_number": "15570",
"document_number": "34651104630",
"financial_institutions_code_number": "329",
"name": "Patrícia Tereza Bernardes",
"ted_account_type": "deposit_account"
}
]
}
BODY PARAMS
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_owner * | object | Objeto Dono da conta | Objeto account_owner |
destination_list | object | lista de contas de destino, que são aquelas para onde é permitida a transferência de recursos. | Objeto destination_list |
Objeto account_owner
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
address | string | Endereço do cliente. | Objeto adress |
birth_date * | string | Data de nascimento da pessoa (formato "AAAA-MM-DD") | |
document_identification * | string | DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente) | |
email * | string | Email do cliente. | |
individual_document_number | string | CPF da pessoa (apenas números). Limitado a 11 caracteres. | |
is_pep * | string | Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | |
mother_name * | string | Nome da mãe do cliente em caso de PF. | 100 |
name * | string | Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. | 100 |
nationality * | string | Nacionalidade do cliente. | 50 |
person_type * | string | Identificador de que o objeto enviado é uma pessoa física ou jurídica. | |
phone | string | Objeto com dados do telefone | Objeto phone |
proof_of_residence | string | DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente). |
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 | 100 |
state * | string | Estado do endereço (com dois caracteres maiúsculos) | 2 |
city * | string | Cidade do endereço | 100 |
neighborhood * | string | Bairro do endereço | 100 |
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 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 |
Objeto destination_list
Campo | Descrição | Exemplo | Máx. Caracteres |
---|---|---|---|
account_branch * | string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 |
account_digit * | string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 |
account_number * | string | Número de telefone (apenas números) | 10 |
document_number * | string | Número de telefone (apenas números) | 10 |
financial_institutions_code_number * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) (com 3 dígitos). | 3 |
name * | string | Nome da pessoa física ou razão social da pessoa jurídica. | 10 |
ted_account_type * | enum | Tipo da conta de destino. | Enumeradores |
Enumeradores ted_account_type
Enumerador | Tradução |
---|---|
checking_account | conta corrente |
deposit_account | conta depósito |
guaranteed_account | conta de garantia |
investment_account | conta de investimento |
payment_account | conta de pagamento |
saving_account | conta poupança |
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\"}"
}