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
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"
    }
}
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 | Caracteres | 
|---|---|---|---|
account_owner * | object | Objeto contendo as informações do Titular da Conta | Objeto account_owner | 
Objeto account_owner
| Campo | Tipo | Descrição | Caracteres | 
|---|---|---|---|
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 | 
documents * | object | Documento(s) do titular da conta | Objeto documents | 
face * | uuidv4 | Chave do reconhecimento facial feito junto ao antifraude (face_recognition_key) | 36 | 
Objeto documents
| Campo | Tipo | Descrição | Caracteres | 
|---|---|---|---|
rg | object | Chaves OCR (OCR keys) do upload da frente e verso do RG do titular | Objeto rg | 
cnh | object | Chave OCR do upload da CNH do titular | Objeto cnh | 
national_registry_of_foreigners | object | Chaves OCR (OCR keys) do upload da frente e verso do RNE do titular | Objeto national_registry_of_foreigners | 
national_migration_registry | object | Chaves OCR (OCR keys) do upload da frente e verso do CRNM do titular | Objeto national_migration_registry | 
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
| Campo | Tipo | Descrição | Caracteres | 
|---|---|---|---|
ocr_front_key * | uuidv4 | Chave OCR do upload da imagem da frente do RG | 36 | 
ocr_back_key * | uuidv4 | Chave OCR do upload da imagem do verso do RG | 36 | 
Objeto cnh
| Campo | Tipo | Descrição | Caracteres | 
|---|---|---|---|
ocr_key * | uuidv4 | Chave OCR do upload da imagem da CNH | 36 | 
Objeto national_registry_of_foreigners
| Campo | Tipo | Descrição | Caracteres | 
|---|---|---|---|
ocr_front_key * | uuidv4 | Chave OCR do upload da imagem da frente do RNE | 36 | 
ocr_back_key * | uuidv4 | Chave OCR do upload da imagem do verso do RNE | 36 | 
Objeto national_migration_registry
| Campo | Tipo | Descrição | Caracteres | 
|---|---|---|---|
ocr_front_key * | uuidv4 | Chave OCR do upload da imagem da frente do CRNM | 36 | 
ocr_back_key * | uuidv4 | Chave OCR do upload da imagem do verso do CRNM | 36 | 
Response
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"
}
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 | Caracteres | 
|---|---|---|---|
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 | Caracteres | 
|---|---|---|---|
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 | 
Response 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 |