Skip to main content

Confirmar 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.

Request

ENDPOINT
/account_request/ACCOUNT_REQUEST_KEY/escrow
MÉTODO
PATCH

Path Params

CampoTipoDescriçãoCaracteres
account_request_keyuuidv4Chave única de identificação solicitação de reserva da conta.36

Abertura de conta Escrow

Request Body
{
"account_owner": {
"address": {
"street": "Av. Brigadeiro Faria Lima",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulistano",
"number": "2391",
"postal_code": "01452905",
"complement": "Complemento"
},
"birth_date": "1990-05-06",
"document_identification": "3884579b-9810-4fa6-9b08-fe67d237160a",
"email": "teste@gmail.com",
"individual_document_number": "99999999999",
"is_pep": false,
"mother_name": "Dona Maria Mariane",
"name": "Nome do Titular da Conta",
"nationality": "nationality",
"person_type": "natural",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"proof_of_residence": "4d7f4e-1eec-4e5f-82c0-d8c3921497ea"
},
"signed_contract": {
"document_key": "48a8f4g9-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.186",
"session_id": "jdifj329842"
},
"signer": {
"name": "Nome do Titular da Conta",
"email": "teste@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "999999999"
},
"authentication_type": "opt-in"
}
]
},
"destinations": [
{
"account_branch": "0001",
"account_number": "1234567",
"account_digit": "1",
"document_number": "04252012000123",
"name": "Conta do FIDC",
"ispb_number": "32402502",
"financial_institution_code_number": "329"
}
],
"additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Request Body Params

CampoTipoDescriçãoCaractéres
account_owner *objectObjeto contendo as informações do Titular da ContaObjeto account_owner
signed_contract *objectObjeto contendo as informações do Titular da ContaObjeto signed_contract
destinations *listLista de contas destino autorizadas a receber transaferências.Objeto destinations
additional_documents *listLista de id's de documentos extras/opcionais .Array de UUID's

Objeto account_owner

CampoTipoDescriçãoCaracteres
address *objectEndereço da pessoa titular da conta.Objeto adress
birth_date *stringData de nascimento da pessoa titular da conta(formato "AAAA-MM-DD")-
document_identification *uuidv4DOCUMENT_KEY do PDF do documento de identificação da pessoa titular da conta com foto (RG ou CNH) (enviado previamente)36
email *stringEmail da pessoa titular da conta.200
individual_document_numberstringCPF da pessoa titular da conta (apenas números). Limitado a 11 caracteres.11
is_pep *stringDeclaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).-
mother_name *stringNome da mãe do cliente em caso de PF.-
name *stringNome do titular da conta.-
nationality *stringNacionalidade do cliente.-
person_type *enumeratorIdentificador de que o objeto enviado é uma pessoa física ou jurídica.Enumeradores person_type
phone *stringObjeto com dados do telefoneObjeto phone
proof_of_residencestringDOCUMENT_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.

CampoTipoDescriçãoCaracteres
street *stringRua do endereço500
state *stringEstado do endereço (com dois caracteres maiúsculos)2
city *stringCidade do endereço255
neighborhood *stringBairro do endereço500
number *stringNúmero da rua10
postal_code *stringCEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)8
complement *stringComplemento do endereço (texto livre)500

Objeto destinations

CampoTipoDescriçãoCaracteres
account_branch *stringNúmero da Agência da conta destino.4
account_number *stringNúmero da conta destino.-
account_digit *stringDígito verificador do número da conta destino.1
document_number *stringCPF/CNPJ do titular da conta destino.-
name stringNome/Razão Social do titular da conta destino.-
ispb_number *stringISPB (base do CNPJ) da instituição financeira da conta destino.8
financial_institution_code_number *stringCódigo da instituição financeira da conta destino.3

Objeto signed_contract

CampoTipoDescriçãoCaracteres
document_key *uuidv4Chave ú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 *listDados de assinatura do documento enviado. Cada item da lista, corresponde a um assinante do documento.Objeto signatures

Objeto signatures

CampoTipoDescriçãoCaracteres
authenticity *objectConjunto de dados que evidenciam a assinatura eletrônica realizada pelo assinante.Objeto authenticity
signer *objectObjeto contendo os dados de um dos assinantes do documento.Objeto signer
authentication_type *enumeratorTipo de assinatura. Sempre será "opt-in""opt-in"

Enumeradores person_type

EnumDescrição
natural *Pessoa Física
legal *Pessoa Jurídica

Objeto authenticity

CampoTipoDescriçãoCaracteres
timestamp *stringData e hora do momento da assinatura do documento.27
facial_recognition_keyuuidv4Chave ú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
langstringCoordenada de longitude da geolocalização do assinante capturada no momento da assinatura.-
latstringCoordenada de latitude da geolocalização do assinante capturada no momento da assinatura.-
ip_addressstringEndereço IP do dispositivo do assinante.-
session_idstringID da seção do assinante no momento da assinatura.-

Objeto signer

CampoTipoDescriçãoCaracteres
name *stringNome do assinante.-
email *stringEmail do assinante.-
phone *objectObjeto com dados do telefone do assinanteObjeto phone
document_number *stringCPF do assinante.11

Objeto phone

CampoDescriçãoExemploMáx. Caracteres
country_code *stringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
area_code *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)3
number *stringNúmero de telefone (apenas números)10

Response

STATUS
201
Response Body
{

"account_key": "e48eb139-448e-43b9-9aee-df5f4b51158c"
}
Atenção

O campo account_key será a chave única de identificação da conta. Toda interação com a conta se dará através dela.

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