API reference - Simplified Credit Insights 1.0.0

API for credit analysis essentials and detailed analysis data

Server

https://api.example.com/v1

Production server

Essentials

GET

/essentials/{analysisId}

Get Analysis Essentials

Retrieve essential credit analysis data for a given analysis

Auth

Path Params

analysisId

string

The unique identifier of the analysis

GET /essentials/{analysisId}

curl --get \

--url 'https://api.example.com/v1/essentials/{analysisId}'

Copy

Responses

200

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)
mainIncome2 fields	object	Main income breakdown
monthlyAmount	number	Total monthly amount
cashFlows3 fields	array[object]
category	string	Enum: `PROVISION_DIRECT_DEBT_RECOVERY`
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: `FEES_DIRECT_DEBT_RECOVERY`,`PROVISION_DIRECT_DEBT_RECOVERY`,`RELEASE_DIRECT_DEBT_RECOVERY`,`FEES_ACCOUNT_SEIZURE`,`PROVISION_ACCOUNT_SEIZURE`,`RELEASE_ACCOUNT_SEIZURE`,`DEBT_COLLECTION`,`REJECTION_CHECK`,`FEES_CHECK_REJECTION`,`FEES_PREVENTIVE_SEIZURE`,`REJECTION_LOAN_REPAYMENT`
loanRepaymentRejections	object
totalRejectedAmount	number
count	integer
creditScore	integer	Overall credit score

Response

{

"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}"

}

Copy

Analysis

GET

/analysis/{analysisId}

Get Full Analysis

Retrieve complete analysis data including scores and credit insights

Auth

Path Params

analysisId

string

The unique identifier of the analysis

GET /analysis/{analysisId}

curl --get \

--url 'https://api.example.com/v1/analysis/{analysisId}'

Copy

Responses

200

Successful response

object	object	Complete analysis data
id	string	Analysis identifier
sessionId	string	Session identifier
parameters4 fields	object
disableScores	boolean
disableCreditInsights	boolean
useBalanceDate	boolean
period3 fields	object
mode	string	Enum: `MONTHS_AND_CURRENT`
numberOfMonths	integer
isComputedUsingProjectConfig	boolean
source	string	Enum: `CLIENT`
dataOrigin	string	Enum: `OPEN_BANKING`
format	string	Enum: `ALGOAN`
status	string	Enum: `COMPLETED`,`PENDING`,`ERROR`
createdAt	date-time
updatedAt	date-time
metadata7 fields	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
scores5 fields	object
creditScore2 fields	object
value	integer
indicators3 fields	object
livingStandard	integer
budgetManagement	integer
financialEvolution	integer
analysisId	string
createdAt	date-time
updatedAt	date-time
usage	string	Enum: `CONSUMER`
creditInsights9 fields	object
cashFlows	array[object]
category	string
totalAmount	number
incomes	object
totalAmount	number
monthlyAmount	number
expenses3 fields	object
totalAmount	number
monthlyAmount	number
categories3 fields	array[object]
monthlyAmount	number
monthlyAmountExcludingMonthsWithoutValues	number
category	string	Enum: `SAVING`,`RENT`
loans2 fields	object
drawdowns2 fields	object
totalAmount	number
lendingOrganizations	array[object]
name	string
repayments3 fields	object
monthlyAmount	number
monthlyAmountExcludingMonthsWithoutValues	number
lendingOrganizations	array[object]
name	string
risks6 fields	object
bailiff	object
totalAmount	number
debtCollection	object
totalAmount	number
gambling	object
totalAmount	number
heavyFailures2 fields	object
directRecoveryOfDebt	object
totalAmount	number
bankAccountSeizure	object
totalAmount	number
incidents2 fields	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

Response

{

"id": "{string}",

"sessionId": "{string}",

"parameters": {

"disableScores": "{boolean}",

"disableCreditInsights": "{boolean}",

"useBalanceDate": "{boolean}",

"period": {

"mode": "{string}",

"numberOfMonths": "{integer}",

"isComputedUsingProjectConfig": "{boolean}"

}

"source": "{string}",

"dataOrigin": "{string}",

"format": "{string}",

"status": "{string}",

"createdAt": "{date-time}",

"updatedAt": "{date-time}",

"metadata": {

"analysisId": "{string}",

"creditInsights": {

"minWindowDate": "{date}",

"maxWindowDate": "{date}"

"creditScore": {

"minWindowDate": "{date}",

"maxWindowDate": "{date}"

"referenceDate": "{date}",

"createdAt": "{date-time}",

"updatedAt": "{date-time}",

"activityScore": {

"value": "{number}"

}

"scores": {

"creditScore": {

"value": "{integer}",

"indicators": {

"livingStandard": "{integer}",

"budgetManagement": "{integer}",

"financialEvolution": "{integer}"

}

"analysisId": "{string}",

"createdAt": "{date-time}",

"updatedAt": "{date-time}",

"usage": "{string}"

"creditInsights": {

"cashFlows": [

{

"category": "{string}",

"totalAmount": "{number}"

}

"incomes": {

"totalAmount": "{number}",

"monthlyAmount": "{number}"

"expenses": {

"totalAmount": "{number}",

"monthlyAmount": "{number}",

"categories": [

{

"monthlyAmount": "{number}",

"monthlyAmountExcludingMonthsWithoutValues": "{number}",

"category": "{string}"

}

]

"loans": {

"drawdowns": {

"totalAmount": "{number}",

"lendingOrganizations": [

{

"name": "{string}"

}

]

"repayments": {

"monthlyAmount": "{number}",

"monthlyAmountExcludingMonthsWithoutValues": "{number}",

"lendingOrganizations": [

{

"name": "{string}"

}

]

}

"risks": {

"bailiff": {

"totalAmount": "{number}"

"debtCollection": {

"totalAmount": "{number}"

"gambling": {

"totalAmount": "{number}"

"heavyFailures": {

"directRecoveryOfDebt": {

"totalAmount": "{number}"

"bankAccountSeizure": {

"totalAmount": "{number}"

}

"incidents": {

"paymentRejections": {

"totalAmount": "{number}"

"checkRejections": {

"totalAmount": "{number}"

}

"overdraft": {

"minimumBalanceReached": "{number}",

"duration": "{integer}"

}

"analysisId": "{string}",

"createdAt": "{date-time}",

"updatedAt": "{date-time}",

"usage": "{string}"

}

Copy