Onboarding

Como criar a conta do tomador e do beneficiário do empréstimo

📘

Lembrete

As informações contidas nessa página aplicam-se apenas ao cadastro de tomador e beneficiário de operações de crédito.

Antes de solicitar uma proposta é necessário que o tomador e o beneficiário do empréstimo sejam cadastrados na plataforma e aprovados pelo nosso compliance.

Abaixo são detalhados os parâmetros esperados no corpo da requisição ao endpoint de criação de conta.

Campo

Requerido

Tipo

Descrição

type

sim

Enum PersonType [PF, PJ]

Tipo da pessoa titular da conta

role

sim

Enum Role [borrower, beneficiary, lender]

Papel do titular da conta

general

sim

Objeto do tipo PersonalBasicData

Dados básicos do titular da conta

address

sim

Objeto do tipo Address

Dados do endereço residencial do titular da conta

job

sim

Objeto do tipo Job

Informações profissionais

financial

sim

Objeto do tipo FinancialInformation

Informações financeiras do titular da conta

bank

sim

Objeto do tipo BankAccount

Dados da conta bancária em que o empréstimo será depositado

contact

sim

Array de objetos do tipo Contact

Dados de contato do titular da conta

documents

sim

Array de objetos do tipo Document

Lista de dados dos documentos do titular da conta

archives

sim

Array de objetos do tipo Archive

Lista de arquivos

PersonalBasicData

Campo

Requerido

Tipo

Descrição

name

sim

Objeto do tipo PersonName

Partes do nome do titular da conta

mother_name

sim

Texto

Nome da mãe do titular da conta, conforme consta no documento da mesma

father_name

sim

Texto

Nome do pai do titular da conta, conforme consta no documento da mesma

date_birth

sim

Texto

Data de nascimento do titular da conta no formato yyyy-MM-dd

city_birth

sim

Texto

Cidade em que o titular da conta nasceu

marital_status

sim

Enum MaritalStatus [casado, solteiro, divorciado, viúvo, outro]

Estado civil do titular da conta

nationaly

sim

Texto

Nacionalidade do titular da conta

gender

sim

Enum Gender [masculino, feminino]

Gênero do titular da conta

pep

sim

Booleano

Flag que sinaliza que o titular da conta é ou não uma pessoa politicamente exposta

PersonName

Campo

Requerido

Tipo

Descrição

first

sim

Texto

Primeiro nome

last

sim

Texto

Sobrenome

Address

Campo

Requerido

Tipo

Descrição

street

sim

Texto

Título e nome do logradouro

number

sim

Texto

Número

complement

não

Texto

Complemento

district

sim

Texto

Bairro

city

sim

Texto

Cidade

zip_code

sim

Texto

CEP

uf

sim

Texto

Estado

country

sim

Texto

País

reference

não

Texto

Ponto de referência

type

sim

Texto

Tipo do endereço. Pode assumir valores como própria, alugada, cedida, etc.

Job

Campo

Requerido

Tipo

Descrição

name

sim

Texto

Nome do cargo exercido

type

sim

Enum HiringFormat [CLT, PJ]

Forma de contratação

FinancialInformation

Campo

Requerido

Tipo

Descrição

profit

sim

Decimal com duas casas de precisão

Renda mensal com base nos últimos três meses

equity

sim

Decimal com duas casas de precisão

Valor aproximado do patrimônio com base nos rendimentos do último ano

BankAccount

Campo

Requerido

Tipo

Descrição

code

sim

Texto

Código curto do banco (compe code)

agency

sim

Texto

Número da agência

dig_agency

não

Texto

Dígito da agência

account

sim

Texto

Número da conta

dig_account

sim

Texto

Dígito da conta

type

sim

Enum BankingType [
001 (conta corrente),
002 (conta poupança),
003 (conta para transações financeiras)]

Tipo da conta

Contact

Campo

Requerido

Tipo

Descrição

email

sim

Texto

Endereço de email

phone_prefix

sim

Número

Prefixo do telefone de contato

phone

sim

Número

Telefone de contato, sem o prefixo

Document

Campo

Requerido

Tipo

Descrição

type

sim

Texto

Identificador único da conta

number

sim

Texto

Número do documento

agent

não

Texto

Órgão emissor

uf

não

Texto

Estado em que o documento foi emitido

exp_date

não

Texto

Data de expiração do documento no formato yyyy-MM-dd

Archive

Campo

Requerido

Tipo

Descrição

tag

sim

Texto

Nome ou identificador do arquivo

type

sim

Texto

Tipo do arquivo

url

sim

Texto

URL por meio da qual o arquivo pode ser acessado / baixado

Na resposta da requisição ao endpoint é retornado o identificador da conta na plataforma (ver exemplo abaixo), o qual deve ser utilizado para consultar seus detalhes.

Exemplo de resposta

{
   "request_id": "0a49471d-1cff-4805-829b-e2409969c111"
}

📘

Dica

Uma alternativa ao uso do identificador retornado na resposta é fornecer o seu próprio. O identificador externo da conta deve ser enviado no cabeçalho da requisição de criação e pode ser usado em lugar do identificador interno para consultar os detalhes da conta. Mais detalhes podem ser obtidos na documentação da API.

Durante o processo de criação da conta é verificada a consistência dos dados(1) fornecidos pelo consumidor (tomador e/ou beneficiário), bem como se os dados e documentos estão em conformidade com as regras da Parati. Caso o resultado da análise seja positivo, a conta é atualizada para o estado Compliant (200) e o correspondente notificado. No entanto, caso seja detectada alguma inconsistência nos dados ou mesmo problemas de conformidade, a conta é bloqueada e o correspondente é notificado sobre os problemas encontrados. Nessa situação o correspondente deve solicitar ao consumidor que atualize as informações fornecidas, as quais devem ser submetidas para uma nova análise por meio do endpoint de atualização da conta, conforme exemplo abaixo.

(1) Entre as verificações realizadas está a dos dados da conta bancária, Esta verificação é feita por meio do envio de um pagamento, via pix, em nome da Parati Financeira.

curl --location --request PATCH 'https://api.parati-cfi.com.br/sandbox/account/497f04a7-a57e-4faa-9316-fdd5a6803d7c \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data-raw '{
    "documents": [
        {
            "type": "cpf",
            "number": "99999999999"
        },
        {
            "type": "rg",
            "number": "12345678",
            "agent": "SSP",
            "uf": "ES",
            "exp_date": "2018-12-07"
        }
    ],
    "bank": {
        "code": "123",
        "agency": "7055",
        "dig_agency": "0",
        "account": "91018",
        "dig_account": "x",
        "type": "001"
    }
}'

🚧

Importante!

Caso se esteja atualizando dados associados a uma propriedade da conta que aceite uma lista de valores é necessário enviar todos os valores da lista.

Webhooks

O mesmo identificador retornado na resposta da requisição é referenciado nas notificações enviadas pela plataforma para informar sobre uma mudança de estado da conta. A estrutura da notificação é detalhada abaixo.

Campo

Requerido

Tipo

Descrição

event

sim

Enum ResourceType [proposal, ccb, lot, account]

Tipo do recurso ao qual o evento se refere

id

sim

Texto

Identificador da conta na plataforma

account_token

sim

Texto

Identificador externo da conta

status

sim

Enum AccountStatus [100, 200, 400, 000]

Situação do recurso no momento do envio da notificação

message

sim

Texto

Descrição da situação da conta

errors

não

Array de objetos do tipo Error

Detalhes dos erros que impediram que a proposta evoluísse como esperado

Error

Campo

Requerido

Tipo

Descrição

code

sim

Número

Código do erro

message

sim

Texto

Descrição do erro

Máquina de estados da conta

Uma conta pode assumir diferentes estados durante seu ciclo de vida, representado no diagrama abaixo.

O propósito / significado de cada estado é descrito na tabela abaixo.

Estado

Descrição

Created (100)

A conta foi criada

Compliant (200)

Os dados e documentos enviados na criação da conta foram analisados e estão em conformidade com as regras / restrições da Parati.

Importante: Apenas contas no estado Compliant (200) podem operar na plataforma.

Blocked (400)

A conta foi bloqueada.

Trata-se de um estado intermediário e uma conta bloqueada tanto pode ser reativada (200) como também pode ser definitivamente desabilitada (000)

Disabled (000)

A conta foi permanentemente desabilitada

Assim que a conta alcançar o estado Compliant (200) estará apta a operar na plataforma.

🚧

Importante!

Nas situações em que tomador e beneficiário são a mesma pessoa é necessário criar apenas uma conta com o papel borrower.


Did this page help you?