Credit Analysis - Legal Entity
To perform the credit analysis of a legal entity, use the Legal Person endpoint.
At the time a legal entity credit analysis is performed, the following data must be sent to our server.
Legal Person Object Definition
Request Body
{
"id": "12345678",
"credit_request_date": "2021-03-31T10:30:00-03:00",
"credit_type": "student_loan",
"legal_name": "QI Tech Tecnologia LTDA",
"trading_name": "QI Tech",
"document_number": "35.472.523/0001-15",
"constitution_date": "2019-11-11",
"constitution_type": "llc",
"email": "suporte.caas@qitech.com.br",
"monthly_revenue": 50000000,
"client_category": "Premium User",
"client_since": "2021-02-11",
"address": {
"country": "BRA",
"street": "Av. Brigadeiro Faria Lima",
"number": "2391",
"neighborhood": "Jardim Paulistano",
"city": "São Paulo",
"uf": "SP",
"postal_code": "01452-905"
},
"phones": [
{
"international_dial_code": "55",
"area_code": "11",
"number": "32234611",
"type": "residential"
}
],
"shareholders": [
{
"name": "Anna Pinto Azevedo",
"document_number": "261.026.462-31",
"birthdate": "1972-08-22",
"email": "annapintoazevedo@sample.com",
"nationality": "BRA",
"mother_name": "Beatrice Rodrigues Pinto",
"father_name": "Luís Azevedo",
"monthly_income": 800000,
"declared_assets": 18600000,
"occupation": "law",
"gender": "female",
"address": {
"country": "BRA",
"street": "Rua Derviche Djouki",
"number": "598",
"complement": "Ap 857",
"neighborhood": "Chora Menino",
"city": "São Paulo",
"uf": "SP",
"postal_code": "02463-080"
},
"phones": [
{
"international_dial_code": "55",
"area_code": "11",
"number": "55988644",
"type": "mobile"
}
]
}
],
"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": "132.23.161.75",
"session_id": "2bb684f9-6c00-4993-bcd7-18b9eccd7c9d"
},
"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 may also, upon agreement with the client, be used for fraud prevention.
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 | Identifier of the credit proposal in your system. It is essential that this number is unique for each credit analysis process |
| registration_id | string | Identifier of the registration in the client’s system. Used to perform more than one analysis related to the same registration |
| credit_request_date | datetime | The date and time when the credit was requested by the applicant |
| credit_type | enum | Type of credit being granted. Currently supported: clean, student_loan, credit_card_limit |
| legal_name | string | Company’s legal name |
| trading_name | string | Company’s trade name |
| document_number | string | The CNPJ, formatted according to the pattern established in this documentation |
| monthly_revenue | integer | Gross monthly revenue in cents |
| client_category | string | Customer category according to your platform’s classification or loyalty program |
| client_since | date | Service start date for this customer |
| constitution_date | date | The company's incorporation date, according to the commercial registry |
| constitution_type | enum | Company’s incorporation type: LLC, corp |
| string | The company representative’s email | |
| address | Address | Company headquarters address |
| phones | list of Phones | Collected phone numbers of the company |
| shareholders | list of NaturalPerson | Company shareholders, in natural person model (NaturalPerson object) |
| guarantors | list of Person | Operation guarantors, either natural (NaturalPerson) or legal (LegalPerson) |
| financial.amount | integer | Total amount being requested by the applicant, which will be disbursed in case of approval |
| financial.currency | enum | Currency unit for the total amount: BRL, USD, EUR |
| interest_type | enum | Debt indexer to be used: cdi_plus, cdi_percentage, price, pre_fixed |
| annual_interest_rate | number | The fixed part of the interest rate, expressed annually as a percentage |
| cdi_percentage | number | The CDI (post-fixed) percentage to be charged |
| number_of_installments | integer | Number of installments |
| warrants | Warrant | Real guarantee data offered in the operation. Must be agreed upon before going live. Currently accepted types: real_estate |
| source | Source | Credit sales channel. Currently accepted values: website and app |
| scr_parameters | ScrParameters | Object with the necessary information to use SCR data in credit analysis |
Submit a Credit Proposal - Legal Person
Request Body
{
"id": "12345678",
...
}
Response Body
{
"id": "12345678",
"analysis_status": "automatically_approved",
"reason": "rule_decision_enum"
}
To evaluate a credit proposal, simply send an object of type LegalPerson to the following endpoint:
POST https://api.caas.qitech.app/credit_analysis/legal_person