Abertura de Conta de Pessoa Física
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.
Solicitar Reserva de Conta
Request
ENDPOINT
/account_request/escrowMÉTODO
POSTRequest Body
{
"account_owner": {
"document_number": "64669455000187",
"email": "marcos.alves@yopmail.com",
"birthdate": "2017-09-16",
"name": "NOME"
}
}
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
Request Body Params
Campo | Tipo | Descrição | Caractéres |
---|---|---|---|
account_owner * | object | Objeto contendo as informações do Titular da Conta | Objeto account_owner |
Objeto account_owner
Campo | Tipo | Descrição | Caractéres |
---|---|---|---|
document_number * | string | CPF do Titular da Conta | 14 |
email * | string | E-mail do Titular da Conta | 200 |
birthdate * | string | Data de nascimento. (formato YYYY-MM-DD) | 10 |
name * | string | Nome do Titular da Conta | 50 |
Response
STATUS
201Response Body
{
"account_info": {
"account_branch": "0001",
"account_digit": "0",
"account_number": "1693580"
},
"account_request_key": "f230f1b5-07af-4737-b0e3-8a472304f5e7",
"account_request_status": "pending_kyc_analysis"
}
Atenção
O campo account_request_key
deve ser armazenado e será utilizado para a confirmação da abertura da conta.
Response Body Params
Campo | Tipo | Descrição | Caractéres |
---|---|---|---|
account_info * | object | Objeto contendo as informações do Titular da Conta | Objeto account_info |
account_request_key * | string | Chave de identificação da requisição de criação | - |
account_request_status * | string | Status de KYC | - |
Objeto account_info
Campo | Tipo | Descrição | Caractéres |
---|---|---|---|
account_branch * | string | Número da Agência | 4 |
account_digit * | string | Dígito da Conta | 11 |
account_number * | string | Número da Conta | 50 |
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 |