Skip to main content

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/escrow
MÉTODO
POST
Request Body
{
"account_owner": {
"document_number": "64669455000187",
"email": "marcos.alves@yopmail.com",
"birthdate": "2017-09-16",
"name": "NOME",
"documents": {
"rg": {
"ocr_front_key": "9d6fefc0-77c9-4acc-8526-53523ff155b9",
"ocr_back_key": "30157d15-3b93-46ad-9c94-cd8bd533f9ed"
},
"cnh": {
"ocr_key": "f30cea56-dd66-415b-9a28-746f7330b708"
}
},
"face": "dbdaf3c9-cdf6-4737-8551-92910b213b7e"
}
}
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

CampoTipoDescriçãoCaractéres
account_owner *objectObjeto contendo as informações do Titular da ContaObjeto account_owner

Objeto account_owner

CampoTipoDescriçãoCaractéres
document_number *stringCPF do Titular da Conta14
email *stringE-mail do Titular da Conta200
birthdate *stringData de nascimento. (formato YYYY-MM-DD)10
name *stringNome do Titular da Conta50
documentsobjectDocumento(s) do titular da contaObjeto documents
faceuuidv4Chave do reconhecimento facial feito junto ao antifraude (face_recognition_key)36

Objeto documents

CampoTipoDescriçãoCaractéres
rgobjectChaves OCR (OCR keys) do upload da frente e verso do RG do titularObjeto rg
cnhobjectChave OCR do upload da CNH do titularObjeto cnh
national_registry_of_foreignersobjectChaves OCR (OCR keys) do upload da frente e verso do RNE do titularObjeto national_registry_of_foreigners
Informação

As chaves OCR (ocr_key ou ocr_front_key e ocr_back_key) do upload das imagens dos documentos são fornecidos como resposta do upload das imagens no antifraude. A face_recognition_key é retornada na resposta do reconhecimento facial.

Objeto rg

CampoTipoDescriçãoCaractéres
ocr_front_key *uuidv4Chave OCR do upload da imagem da frente do RG36
ocr_back_key *uuidv4Chave OCR do upload da imagem do verso do RG36

Objeto cnh

CampoTipoDescriçãoCaractéres
ocr_key *uuidv4Chave OCR do upload da imagem da CNH36

Objeto national_registry_of_foreigners

CampoTipoDescriçãoCaractéres
ocr_front_key *uuidv4Chave OCR do upload da imagem da frente do RNE36
ocr_back_key *uuidv4Chave OCR do upload da imagem do verso do RNE36

Response

STATUS
201
Response 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

CampoTipoDescriçãoCaractéres
account_info *objectObjeto contendo as informações do Titular da ContaObjeto account_info
account_request_key *stringChave de identificação da requisição de criação-
account_request_status *stringStatus de KYC-

Objeto account_info

CampoTipoDescriçãoCaractéres
account_branch *stringNúmero da Agência4
account_digit *stringDígito da Conta11
account_number *stringNúmero da Conta50
STATUS
4xx
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
Código HTTP
status
Código QI
code
Título
title
Descrição (eng)
description
Descrição(ptbr)
translation
400QIT000001Bad RequestSchema ErrorErro de Schema
404QIT000404Not FoundResource could not be foundRecurso não encontrado