List all available API to get and create Score and Analysis.
Each requests must be set with an Authorization header using a Bearer JSON Web Token after authenticating with your client credentials.
Authentication
Algoan provides JSON Web Tokens based on the OAuth2 protocol to authenticate your organization.
When you create a new project, you will need to use the service account shared by Algoan containing a client_id and a client_secret.
NOTE: this is the only API where request's parameters are formatted as snake case.
Create a new access token
Generates a new access token to use Algoan's APIs
OAuth2 request body with two grant types - client_credentials and refresh_token
Access Token instance
Customer
represents a user able to connect/aggregate their bank accounts. It is unique per organization, project and custom identifier.
Analysis
An analysis is a snapshot of a customer's financial situation based on the connected bank accounts. It contains results from both products Score and Credit Insights.
NOTE: To get Credit Insights results or a Score, the analysis need to contain at least one CHECKING Account with a minimum of 20 transactions.
Credit Insights
The Credit Insights model contains a list of indicators related to the customer's financial situation. It is divided into five parts:
- Incomes: contains information about the customer’s incomes with the related transactions ordered by category.
- Expenses: contains information about the customer's expenses with the related transactions ordered by category.
- Loans: provides details on the customer’s loans.
- Risk Indicators: contains indicators related to Credit Risk.
- Cash Flows: groups transactions that share some similarities in descriptions, amounts and regularity.
Score
Score attached to the analysis
Account
Bank accounts attached to a customer
Transaction
Transactions attached to a Customer's bank account
Subscription
Subscription to Algoan's platform events.
Event
Event related to webhooks' subscriptions
Report
A report provides a detailed comparison between different analyses conducted over time. It captures the results of three analyses at different time points:
- Latest analysis: the last completed analysis for a given customer when the report is created.
- Previous analysis: the penultimate completed analysis for a given customer when the report is created.
- First analysis: The first completed analysis for a given customer, which usually represents the analysis from the credit underwriting decision.
According to our internal statistics, approximately 20% of defaults occur within the first six months of a loan's lifespan. This underscores the urgency of having accurate and up-to-date information when assessing risk and making financial decisions.
The /reports endpoint offers a detailed comparison report that helps monitor customer credit over time, showing changes from the initial credit analysis to the most current.
Transaction Data
endpoints attached to our Transaction Data Product. Transaction Data is a product that enables your prospects to easily share their Open Banking Data.