Onboarding

📘

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.

PersonalBasicData

PersonName

Address

Job

FinancialInformation

BankAccount

Contact

Document

Archive

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.

Error

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.

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.