API for credit analysis essentials and detailed analysis data
Production server
Essentials
Get Analysis Essentials
Retrieve essential credit analysis data for a given analysis
| analysisId | string | The unique identifier of the analysis |
curl --get \ --url 'https://api.example.com/v1/essentials/{analysisId}'Successful response
| object | object | Essential credit analysis summary | |
| analysisId | string | Unique identifier of the analysis | |
| createdAt | date-time | Creation timestamp | |
| updatedAt | date-time | Last update timestamp | |
| activityScore | number | Activity score (0-100) | |
| mainIncome | object | Main income breakdown | |
| monthlyAmount | number | Total monthly amount | |
| cashFlows | array[object] | ||
| category | string | Enum: | |
| monthlyAmount | number | ||
| employer | string | ||
| monthlyRegularIncome | number | Total monthly regular income | |
| monthlyEssentialExpenses | number | Total monthly essential expenses | |
| monthlyLoanRepayments | number | Total monthly loan repayments | |
| monthlyDiscretionaryIncome | number | Discretionary income after expenses | |
| debtToIncome | number | Debt-to-income ratio | |
| redFlags | array[string] | List of identified risk flags Enum: | |
| loanRepaymentRejections | object | ||
| totalRejectedAmount | number | ||
| count | integer | ||
| creditScore | integer | Overall credit score |
{ "analysisId": "{string}", "createdAt": "{date-time}", "updatedAt": "{date-time}", "activityScore": "{number}", "mainIncome": { "monthlyAmount": "{number}", "cashFlows": [ { "category": "{string}", "monthlyAmount": "{number}", "employer": "{string}" } ] }, "monthlyRegularIncome": "{number}", "monthlyEssentialExpenses": "{number}", "monthlyLoanRepayments": "{number}", "monthlyDiscretionaryIncome": "{number}", "debtToIncome": "{number}", "redFlags": [ "{array[string]...}" ], "loanRepaymentRejections": { "totalRejectedAmount": "{number}", "count": "{integer}" }, "creditScore": "{integer}"}Analysis
Get Full Analysis
Retrieve complete analysis data including scores and credit insights
| analysisId | string | The unique identifier of the analysis |
curl --get \ --url 'https://api.example.com/v1/analysis/{analysisId}'Successful response
| object | object | Complete analysis data | |
| id | string | Analysis identifier | |
| sessionId | string | Session identifier | |
| parameters | object | ||
| disableScores | boolean | ||
| disableCreditInsights | boolean | ||
| useBalanceDate | boolean | ||
| period | object | ||
| mode | string | Enum: | |
| numberOfMonths | integer | ||
| isComputedUsingProjectConfig | boolean | ||
| source | string | Enum: | |
| dataOrigin | string | Enum: | |
| format | string | Enum: | |
| status | string | Enum: | |
| createdAt | date-time | ||
| updatedAt | date-time | ||
| metadata | object | ||
| analysisId | string | ||
| creditInsights | object | ||
| minWindowDate | date | ||
| maxWindowDate | date | ||
| creditScore | object | ||
| minWindowDate | date | ||
| maxWindowDate | date | ||
| referenceDate | date | ||
| createdAt | date-time | ||
| updatedAt | date-time | ||
| activityScore | object | ||
| value | number | ||
| scores | object | ||
| creditScore | object | ||
| value | integer | ||
| indicators | object | ||
| livingStandard | integer | ||
| budgetManagement | integer | ||
| financialEvolution | integer | ||
| analysisId | string | ||
| createdAt | date-time | ||
| updatedAt | date-time | ||
| usage | string | Enum: | |
| creditInsights | object | ||
| cashFlows | array[object] | ||
| category | string | ||
| totalAmount | number | ||
| incomes | object | ||
| totalAmount | number | ||
| monthlyAmount | number | ||
| expenses | object | ||
| totalAmount | number | ||
| monthlyAmount | number | ||
| categories | array[object] | ||
| monthlyAmount | number | ||
| monthlyAmountExcludingMonthsWithoutValues | number | ||
| category | string | Enum: | |
| loans | object | ||
| drawdowns | object | ||
| totalAmount | number | ||
| lendingOrganizations | array[object] | ||
| name | string | ||
| repayments | object | ||
| monthlyAmount | number | ||
| monthlyAmountExcludingMonthsWithoutValues | number | ||
| lendingOrganizations | array[object] | ||
| name | string | ||
| risks | object | ||
| bailiff | object | ||
| totalAmount | number | ||
| debtCollection | object | ||
| totalAmount | number | ||
| gambling | object | ||
| totalAmount | number | ||
| heavyFailures | object | ||
| directRecoveryOfDebt | object | ||
| totalAmount | number | ||
| bankAccountSeizure | object | ||
| totalAmount | number | ||
| incidents | object | ||
| paymentRejections | object | ||
| totalAmount | number | ||
| checkRejections | object | ||
| totalAmount | number | ||
| overdraft | object | ||
| minimumBalanceReached | number | ||
| duration | integer | ||
| analysisId | string | ||
| createdAt | date-time | ||
| updatedAt | date-time | ||
| usage | string |
xxxxxxxxxx{ "id": "{string}", "sessionId": "{string}", "parameters": {...}, "source": "{string}", "dataOrigin": "{string}", "format": "{string}", "status": "{string}", "createdAt": "{date-time}", "updatedAt": "{date-time}", "metadata": {...}, "scores": {...}, "creditInsights": {...}}