Abertura de conta PF
Request
ENDPOINT
/accountMETHOD
POSTRequest Body
{
"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": "api@qitech.com.br",
"individual_document_number": "34651104630",
"is_pep": false,
"mother_name": "Maria Mariane",
"name": "Qi Tech Ltda.",
"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.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"
}
]
}
}
Copiando e Colando o Payload de exemplo
Antes de iniciar os testes, a document_key do campo document_identification deve ser substituida pela chave retornada no upload de documentos dos titulares da conta.
Mock de CPF/CNPJ
Para simular situações de aprovação, reprovação e analise manual pode ser utilizado o primeiro digito do CPF/CNPJ do owner da conta:
0 à 7 -> Análise Manual
8 -> Reprovação Automática
9 -> Aprovação Automática
BODY PARAMS
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
account_owner | object | Objeto Dono da conta | Object account_owner |
signed_contract * | object | Objeto contento as informações da assinatura do contrato. | Object signed_contract |
Object account_owner
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
address | string | Endereço do cliente. | Object 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) | |
document_identification_back * | string | DOCUMENT_KEY do PDF do verso documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente) | |
document_identification_type * | string | Tipo do documento enviado previamente (RG ou CNH) | |
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 | Object phone |
proof_of_residence | string | DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente). |
Object 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 |
Object 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 |
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 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": "70091",
"financial_institution_code": "329",
"account_key": "7986dcc7-4331-478f-af47-adfbdf7f4a36"
},
"account_owner": {
"document_number": "08141163701",
"name": "Aurora Simone Catarina Nogueira"
}
},
"event_datetime": "2019-11-04 16:34:41",
"key": "f834af4d-ab4b-442f-96c9-f9940d8066d4",
"status": "pending_kyc_analysis",
"webhook_type": "account"
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}