Credit Analysis - Natural Person
To perform a credit analysis for a natural person, use the NaturalPerson endpoint.
When a natural person credit analysis is done, the following data must be sent to our server.
Natural Person Object Definition
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" : {
...
}
}
A credit analysis must be submitted to the API before disbursement and can be used to decide whether or not to grant credit. The submitted data can also, by agreement with the client, be used for fraud prevention purposes.
The objects used in the composition of the CreditProposal object and not defined in this section are available in the Shared Objects section.
| name | type | description |
|---|---|---|
| id | string | Credit proposal identifier in your system. This number must be unique for each credit analysis process (required) |
| registration_id | string | Identifier of the registration in the client’s system. Use the same registration_id for multiple analyses referring to the same registration |
| credit_request_date | datetime | The date and time when the credit was requested by the applicant (required) |
| credit_type | enum | Type of credit being granted. Currently supported: clean, student_loan, credit_card_limit |
| name | string | Full name of the individual being registered |
| document_number | string | CPF of the individual being registered, with dots and hyphens, according to formatting standards (required) |
| birthdate | date | Date of birth of the individual according to the formatting standard |
| gender | enum | Gender of the individual: 'male', 'female' or 'undefined' |
| nationality | string | Nationality of the individual, in ISO 3166-1 alpha-3 format |
| mother_name | string | Full name of the mother |
| father_name | string | Full name of the father |
| monthly_income | integer | Gross monthly income in cents |
| declared_assets | integer | Declared assets in cents |
| client_category | string | Client category according to your platform classification or loyalty program |
| client_since | date | Service start date for this client |
| occupation | string | Profession of the individual being registered |
| string | The person's email address | |
| documents | Document | Objects of type CNH and RG |
| address | Address | Object of type Address describing the individual’s residence |
| phones | List of Phones | List of Phone objects containing the individual’s phone numbers |
| guarantors | List of Person | Guarantors of the operation, either individuals (NaturalPerson) or legal entities (LegalPerson) |
| financial.amount | integer | Total amount requested by the applicant, which will be disbursed upon approval, in cents |
| financial.currency | enum | Currency unit of the total amount: BRL, USD, EUR |
| interest_type | enum | Debt index to be used: cdi_plus, cdi_percentage, price, pre_fixed |
| annual_interest_rate | number | Pre-fixed interest rate percentage per year |
| cdi_percentage | number | CDI percentage (post-fixed) of the interest to be charged |
| number_of_installments | integer | Number of installments |
| warrants | Warrant | Real guarantees offered in the operation. Must be agreed upon before going live. Currently accepted types: real_estate |
| source | Source | Credit sales channel. Currently accepted: website and app |
| scr_parameters | ScrParameters | Object with the necessary information for using SCR data in the credit analysis |
Attention
The scr_parameters property is only required if the client has contracted and wishes to use the SCR consultation in the credit analysis.
Submit a Credit Proposal – Natural Person
Request Body
{
"id": "12345678",
...
}
Response Body
{
"id": "12345678",
"analysis_status": "automatically_approved",
"reason": "rule_decision_enum"
}
To perform the evaluation of a credit proposal, simply send an object of type NaturalPerson to the following endpoint:
POST https://api.caas.qitech.app/credit_analysis/natural_person