Pular para o conteúdo principal

Análise de Crédito - Pessoa Física

Para realizar a análise de crédito de uma pessoa física, utilize o endpoint de NaturalPerson.

No momento em que uma análise de crédito de pessoa física for realizada, os seguintes dados abaixo devem ser enviados para o nosso servidor.

Definição do Objeto Natural Person

Request Body
{
"id": "12345678",
"registration_id":"444",
"credit_request_date": "2021-03-31T10:30:00-03:00",
"credit_type": "student_loan",
"name": "Victor Silva Barbosa",
"document_number": "199.208.915-92",
"birthdate": "1990-01-01",
"email": "exemplo@sample.com",
"nationality": "BRA",
"gender": "male",
"mother_name": "Ana Barbosa",
"father_name": "João Silva",
"monthly_income": 30000,
"declared_assets": 7500000,
"occupation": "pedagogy",
"address": {
"country": "BRA",
"street": "Rua Curitiba",
"number": "150",
"complement": "Bl 3 apt 122",
"neighborhood": "Paraíso",
"city": "São Paulo",
"uf": "SP",
"postal_code": "04005-030"
},
"phones": [
{
"international_dial_code": "55",
"area_code": "11",
"number": "32234611",
"type": "residential"
}
],
"guarantors": [
{
"name": "Melissa Lima Melo",
"document_number": "677.498.846-61",
"birthdate": "1960-11-21",
"email": "exemplo2@sample.com",
"nationality": "BRA",
"mother_name": "Raíssa Lima",
"father_name": "Ronaldo Melo",
"monthly_income": 800000,
"declared_assets": 18600000,
"occupation": "law",
"gender": "female",
"address": {
"country": "BRA",
"street": "Rua Castro Alves",
"number": "100",
"complement": "Ap 202",
"neighborhood": "Parque Estrela Dalva I",
"city": "Luziânia",
"uf": "GO",
"postal_code": "72804-050"
},
"phones": [
{
"international_dial_code": "55",
"area_code": "11",
"number": "21158745",
"type": "residential"
}
]
}
],
"financial": {
"amount": 100000,
"currency": "BRL",
"interest_type": "cdi_plus",
"annual_interest_rate": 2.32,
"cdi_percentage": 100,
"number_of_installments": 4
},
"warrants": [
{
"warrant_type": "real_estate",
"address": {
"country": "BRA",
"street": "Rua Curitiba",
"number": "150",
"complement": "Bl 3 apt 122",
"neighborhood": "Paraíso",
"city": "São Paulo",
"uf": "SP",
"postal_code": "04005-030"
},
"property_type": "house",
"estimated_value": 100000000,
"forced_selling_value": 60000000
}
],
"source": {
"channel": "website",
"ip": "145.25.145.32",
"session_id": "bec256b3-5265-4dcb-bc55-2e4fb43983e0"
},
"scr_parameters" : {
...
}
}

Uma análise de crédito deve ser enviada para a API antes do desembolso e pode ser utilizada para se tomar a decisão de conceder ou não o crédito. Os dados enviados também podem, mediante acordo com o cliente, ser utilizados para a prevenção a fraudes.

Os objetos utilizados na composição do objeto CreditProposal e não definidos nesta seção estão disponíveis na seção Objetos Compartilhados.

nometipodescrição
idstringIdentificador da proposta de crédito no seu sistema.
É essencial que este número seja único para cada processo de análise de crédito (obrigatório)
registration_idstringIdentificador do cadastro no sistema do cliente. Para realizar mais de uma análise referente a um mesmo cadastro
credit_request_datedatetimeA data e hora quando o crédito foi requisitado pelo tomador (obrigatório)
credit_typeenumTipo de crédito sendo concedido. No momento são suportados: clean, student_loan, credit_card_limit
namestringNome completo do indivíduo sendo cadastrado
document_numberstringCPF do indivíduo sendo cadastrado, com pontos e hífens, de acordo com a padronização (obrigatório)
birthdatedateData de nascimento do indivíduo de acordo com a padronização
genderenumGênero do indivíduo: 'male', 'female' ou 'undefined'
nationalitystringA nacionalidade do cadastro, em ISO 3166-1 alfa-3
mother_namestringNome completo da mãe
father_namestringNome completo do pai
monthly_incomeintegerRenda mensal bruta em centavos
declared_assetsintegerPatrimônio declarado em centavos
client_categorystringCategoria do cliente de acordo com a classificação da sua plataforma ou seu programa de fidelidade
client_sincedateData de início da prestação de serviços para este cliente
occupationstringProfissão do indivíduo sendo cadastrado
emailstringO email da pessoa
documentsDocumentObjetos do tipo CNH e RG
addressAddressObjeto do tipo Address que descreve o endereço da moradia do indivíduo
phonesLista de PhonesLista de objetos do tipo phone que possui a lista de telefones do indivíduo
guarantorslist of PersonGarantidores da operação, Pessoa física (NaturalPerson) ou jurídica (LegalPerson)
financial.amountintegerO valor total sendo requerido pelo tomador, que será liberado em caso de aprovação em centavos
financial.currencyenumA unidade monetária referente ao valor total: BRL, USD, EUR
interest_typeenumO indexador da dívida que será utilizado: cdi_plus, cdi_percentage, price, pre_fixed
annual_interest_ratenumberO valor da parte pré-fixada do juros, em percentual ao ano
cdi_percentagenumberO percentual do CDI (Pós) do juros a ser cobrado
number_of_installmentsintegerNúmero de parcelas
warrantsWarrantDados de garantias reais oferecidas na operação. Deverá ser acordada antes da entrada em produção. Atualmente os seguintes tipos são aceitos: real_estate
sourceSourceO canal de venda do crédito. Atualmente são aceitos: website e app
scr_parametersScrParametersObjeto com as informações necessárias para a utilização das informações do SCR na análise de crédito
Atenção

A propriedade scr_parameters é obrigatória apenas se o cliente contratou e deseja utilizar a consulta SCR na análise de crédito.

Enviar uma Proposta de Crédito - Pessoa Física

Request Body
  {
"id": "12345678",
...
}
Response Body
{
"id": "12345678",
"analysis_status": "automatically_approved",
"reason": "rule_decision_enum"
}

Para realizar a avaliação de uma proposta de crédito, basta enviar um objeto do tipo NaturalPerson ao seguinte endpoint:

POST https://api.caas.qitech.app/credit_analysis/natural_person