API reference Algoan Pro 2.0.0 Private License

List all available APIs to get and create Score and Analysis for businesses.

Server

https://api.algoan.com

Authentication

Each request 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.

POST

/v1/oauth/token

Create a new access token

Generates a new access token to use Algoan's APIs

Auth

Request Body

OAuth2 request body with two grant types - client_credentials and refresh_token

object	object	Auth request body to generate a new access token
client_id	string	Your client ID
client_secret	uuid	Your client secret
grant_type	string	Specify the type of grant access Enum: `client_credentials`

POST /v1/oauth/token

 
curl --request POST \ --url 'https://api.algoan.com/v1/oauth/token'
Copy

Responses

200

Access Token instance

object	object
access_token	string	The access token required for each API.
expires_in	number	Number of seconds until the access token expires
refresh_expires_in	number	Number of seconds until the refresh token expires
refresh_token	string	Refresh token used to generate a new access token
token_type	string	Type of access token (will always be set to `Bearer`)

400

Bad request, invalid input parameters

Response

 
{ "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIi...5jUKEv5KyzShp5pqg", "expires_in": 86400, "refresh_expires_in": 864000, "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5...fsWGA82PQC_6OXoyU4", "token_type": "Bearer"}
Copy

Business

represents a business able to connect/aggregate their bank accounts. It is unique per organization, project and custom identifier.

/v2/businesses/{businessId}

PATCH

/v2/businesses/{businessId}

Find a list of businesses

Auth

GET /v2/businesses

 
curl --get \ --url 'https://api.algoan.com/v2/businesses' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
resources	array
id	string	Id of the customer
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
connect	object	Properties of the customer for the Connect product Deprecated
serviceAccountClientId	string	Client Id of the corresponding service account
dashboard13 fields	object	Dashboard Property of the customer for the new dashboard. Only present if the project contains the dashboard product.
currentState	string	Current state of the customer's report Enum: `NEW`,`VIEWED`,`ARCHIVED`
historyState3 fields	array[object]	States history: represents an array containing the history of the customer's report
createdAt	string	The date the state was created at
state	string	State of this report Enum: `NEW`,`VIEWED`,`ARCHIVED`
userId	string	User that consulted the dashboard and changed the report state
invitationHistory4 fields	array[object]	Invitation history: represents an array containing the history of the customer's invitations
date	string	The date of the event
type	string	type of the event Enum: `invitation_link_sent`,`invitation_link_retrieved`,`invitation_link_created`
channel	string	Channel of the invitation email or sms Enum: `email`,`sms`
senderUsername	string	The username of the sender
numberOfViews	number	Number of times the report was viewed
numberOfAnalyses	number	Number of COMPLETED analyses linked to the customer Deprecated
newWithAnalysis	boolean	New with analysis
onboarding	object	New with analysis
team	string	Team corresponding to the customer's dashboard
customizedMonthlyAmount	number	Monthly amount set by customer
analysesConfig	object	Analyses config of the customer: 1st string key of the map is an analysis Id 2st string key of the map is a cash flow Id
*	object
*	object
isIncludedInRemainderToLive	boolean	Indicate if the cashflow is included in the calculation of remainder to live
comments4 fields	array[object]	Customer comments
value	string	Value of the comment
authorEmail	string	Electronic mail address of comment author
createdAt	date-time	Creation date of the comment
updatedAt	date-time	Last update date of the comment
createdAt	string	Creation date
updatedAt	string	Last update date
openBankingInformation	object	Information about the customer retrieved from open banking
owners	array[object]	Account owners information
name	string	Name of the owner of the account
reports4 fields	object	Reported information about customer's analyses
completedAnalyses3 fields	object	Reported information about customer's completed analyses
count	number	Number of analyses completed linked to the customer
date	string	Date of the last analysis completed for the customer
url	string	URL of the last analysis completed for the customer
lastFailedAnalysis3 fields	object	Reported information about customer's last analysis in error
date	string	Date of the last analysis failed for the customer
url	string	URL of the last analysis failed for the customer
type	string	Type of the last analysis failed for the customer
userJourneyState	string	Reported information about customer's last state in the user journey Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
pdfProcessingState	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
owner3 fields	object	The organization and project where the customer belongs to originally
organizationId	string	The organization's id
projectId	string	The project's id
projectName	string	The project's name
shares3 fields	array[object]	The projects that the customer is shared with
organizationId	string	The organization's id
projectId	string	The project's id
sharedAt	string	The time of share
storage4 fields	object	Storage Properties of the customer
type	string	Type of storage when customer data is expired Enum: `DELETION`,`PARTIAL_DELETION`,`DEMO`
expiresAt	date-time	Expiration date of customer data
partiallyExpiresAt	date-time	Partial expiration date of customer data
isAnonymized	boolean	Indicates if the customer has been anonymized after expiration
createdAt	string	Creation date of the customer
updatedAt	string	Last date of update of the customer
usage	string	Usage type of the customer: Business or Consumer Enum: `CONSUMER`,`BUSINESS`
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Personal information about the business customer
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

401

Authentication required

403

Insufficient permissions

Response

xxxxxxxxxx
 
{
 "resources": [...],
 "pagination": {...}
}
Copy

Create a new business

Auth

Request Body

The data for business creation

object	object
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Personal information about the business

POST /v2/businesses

 
curl --request POST \ --url 'https://api.algoan.com/v2/businesses' \ --header 'Authorization: Bearer {token}' \ --data '{  "customIdentifier": "{string}",  "aggregationDetails": {    "userId": "{string}",    "aggregatorName": "{string}",    "callbackUrl": "{string}",    "token": "{string}",    "mode": "{string}",    "redirectUrl": "{string}",    "apiUrl": "{string}",    "iframeUrl": "{string}",    "clientId": "{string}"  },  "userSegment": "{string}",  "businessDetails": {}}'
Copy

Responses

201

Created

object	object
id	string	Id of the customer
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
connect	object	Properties of the customer for the Connect product Deprecated
serviceAccountClientId	string	Client Id of the corresponding service account
dashboard13 fields	object	Dashboard Property of the customer for the new dashboard. Only present if the project contains the dashboard product.
currentState	string	Current state of the customer's report Enum: `NEW`,`VIEWED`,`ARCHIVED`
historyState3 fields	array[object]	States history: represents an array containing the history of the customer's report
createdAt	string	The date the state was created at
state	string	State of this report Enum: `NEW`,`VIEWED`,`ARCHIVED`
userId	string	User that consulted the dashboard and changed the report state
invitationHistory4 fields	array[object]	Invitation history: represents an array containing the history of the customer's invitations
date	string	The date of the event
type	string	type of the event Enum: `invitation_link_sent`,`invitation_link_retrieved`,`invitation_link_created`
channel	string	Channel of the invitation email or sms Enum: `email`,`sms`
senderUsername	string	The username of the sender
numberOfViews	number	Number of times the report was viewed
numberOfAnalyses	number	Number of COMPLETED analyses linked to the customer Deprecated
newWithAnalysis	boolean	New with analysis
onboarding	object	New with analysis
team	string	Team corresponding to the customer's dashboard
customizedMonthlyAmount	number	Monthly amount set by customer
analysesConfig	object	Analyses config of the customer: 1st string key of the map is an analysis Id 2st string key of the map is a cash flow Id
*	object
*	object
isIncludedInRemainderToLive	boolean	Indicate if the cashflow is included in the calculation of remainder to live
comments4 fields	array[object]	Customer comments
value	string	Value of the comment
authorEmail	string	Electronic mail address of comment author
createdAt	date-time	Creation date of the comment
updatedAt	date-time	Last update date of the comment
createdAt	string	Creation date
updatedAt	string	Last update date
openBankingInformation	object	Information about the customer retrieved from open banking
owners	array[object]	Account owners information
name	string	Name of the owner of the account
reports4 fields	object	Reported information about customer's analyses
completedAnalyses3 fields	object	Reported information about customer's completed analyses
count	number	Number of analyses completed linked to the customer
date	string	Date of the last analysis completed for the customer
url	string	URL of the last analysis completed for the customer
lastFailedAnalysis3 fields	object	Reported information about customer's last analysis in error
date	string	Date of the last analysis failed for the customer
url	string	URL of the last analysis failed for the customer
type	string	Type of the last analysis failed for the customer
userJourneyState	string	Reported information about customer's last state in the user journey Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
pdfProcessingState	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
owner3 fields	object	The organization and project where the customer belongs to originally
organizationId	string	The organization's id
projectId	string	The project's id
projectName	string	The project's name
shares3 fields	array[object]	The projects that the customer is shared with
organizationId	string	The organization's id
projectId	string	The project's id
sharedAt	string	The time of share
storage4 fields	object	Storage Properties of the customer
type	string	Type of storage when customer data is expired Enum: `DELETION`,`PARTIAL_DELETION`,`DEMO`
expiresAt	date-time	Expiration date of customer data
partiallyExpiresAt	date-time	Partial expiration date of customer data
isAnonymized	boolean	Indicates if the customer has been anonymized after expiration
createdAt	string	Creation date of the customer
updatedAt	string	Last date of update of the customer
usage	string	Usage type of the customer: Business or Consumer Enum: `CONSUMER`,`BUSINESS`
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Personal information about the business customer

400

Validation failed

401

Authentication required

403

Insufficient permissions

422

customIdentifier already exists

Response

 
{ "id": "{string}", "customIdentifier": "{string}", "aggregationDetails": {  "userId": "{string}",  "aggregatorName": "{string}",  "callbackUrl": "{string}",  "token": "{string}",  "mode": "{string}",  "redirectUrl": "{string}",  "apiUrl": "{string}",  "iframeUrl": "{string}",  "clientId": "{string}" }, "connect": {  "serviceAccountClientId": "{string}" }, "dashboard": {  "currentState": "{string}",  "historyState": [   {    "createdAt": "{string}",    "state": "{string}",    "userId": "{string}"   }  ],  "invitationHistory": [   {    "date": "{string}",    "type": "{string}",    "channel": "{string}",    "senderUsername": "{string}"   }  ],  "numberOfViews": "{number}",  "numberOfAnalyses": "{number}",  "newWithAnalysis": "{boolean}",  "onboarding": {},  "team": "{string}",  "customizedMonthlyAmount": "{number}",  "analysesConfig": {},  "comments": [   {    "value": "{string}",    "authorEmail": "{string}",    "createdAt": "{date-time}",    "updatedAt": "{date-time}"   }  ],  "createdAt": "{string}",  "updatedAt": "{string}" }, "openBankingInformation": {  "owners": [   {    "name": "{string}"   }  ] }, "reports": {  "completedAnalyses": {   "count": "{number}",   "date": "{string}",   "url": "{string}"  },  "lastFailedAnalysis": {   "date": "{string}",   "url": "{string}",   "type": "{string}"  },  "userJourneyState": "{string}",  "pdfProcessingState": "{string}" }, "owner": {  "organizationId": "{string}",  "projectId": "{string}",  "projectName": "{string}" }, "shares": [  {   "organizationId": "{string}",   "projectId": "{string}",   "sharedAt": "{string}"  } ], "storage": {  "type": "{string}",  "expiresAt": "{date-time}",  "partiallyExpiresAt": "{date-time}",  "isAnonymized": "{boolean}" }, "createdAt": "{string}", "updatedAt": "{string}", "usage": "{string}", "userSegment": "{string}", "businessDetails": {}}
Copy

Find a business by its id

Auth

Path Params

businessId

string

The business id

GET /v2/businesses/{businessId}

 
curl --get \ --url 'https://api.algoan.com/v2/businesses/{businessId}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	string	Id of the customer
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
connect	object	Properties of the customer for the Connect product Deprecated
serviceAccountClientId	string	Client Id of the corresponding service account
dashboard13 fields	object	Dashboard Property of the customer for the new dashboard. Only present if the project contains the dashboard product.
currentState	string	Current state of the customer's report Enum: `NEW`,`VIEWED`,`ARCHIVED`
historyState3 fields	array[object]	States history: represents an array containing the history of the customer's report
createdAt	string	The date the state was created at
state	string	State of this report Enum: `NEW`,`VIEWED`,`ARCHIVED`
userId	string	User that consulted the dashboard and changed the report state
invitationHistory4 fields	array[object]	Invitation history: represents an array containing the history of the customer's invitations
date	string	The date of the event
type	string	type of the event Enum: `invitation_link_sent`,`invitation_link_retrieved`,`invitation_link_created`
channel	string	Channel of the invitation email or sms Enum: `email`,`sms`
senderUsername	string	The username of the sender
numberOfViews	number	Number of times the report was viewed
numberOfAnalyses	number	Number of COMPLETED analyses linked to the customer Deprecated
newWithAnalysis	boolean	New with analysis
onboarding	object	New with analysis
team	string	Team corresponding to the customer's dashboard
customizedMonthlyAmount	number	Monthly amount set by customer
analysesConfig	object	Analyses config of the customer: 1st string key of the map is an analysis Id 2st string key of the map is a cash flow Id
*	object
*	object
isIncludedInRemainderToLive	boolean	Indicate if the cashflow is included in the calculation of remainder to live
comments4 fields	array[object]	Customer comments
value	string	Value of the comment
authorEmail	string	Electronic mail address of comment author
createdAt	date-time	Creation date of the comment
updatedAt	date-time	Last update date of the comment
createdAt	string	Creation date
updatedAt	string	Last update date
openBankingInformation	object	Information about the customer retrieved from open banking
owners	array[object]	Account owners information
name	string	Name of the owner of the account
reports4 fields	object	Reported information about customer's analyses
completedAnalyses3 fields	object	Reported information about customer's completed analyses
count	number	Number of analyses completed linked to the customer
date	string	Date of the last analysis completed for the customer
url	string	URL of the last analysis completed for the customer
lastFailedAnalysis3 fields	object	Reported information about customer's last analysis in error
date	string	Date of the last analysis failed for the customer
url	string	URL of the last analysis failed for the customer
type	string	Type of the last analysis failed for the customer
userJourneyState	string	Reported information about customer's last state in the user journey Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
pdfProcessingState	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
owner3 fields	object	The organization and project where the customer belongs to originally
organizationId	string	The organization's id
projectId	string	The project's id
projectName	string	The project's name
shares3 fields	array[object]	The projects that the customer is shared with
organizationId	string	The organization's id
projectId	string	The project's id
sharedAt	string	The time of share
storage4 fields	object	Storage Properties of the customer
type	string	Type of storage when customer data is expired Enum: `DELETION`,`PARTIAL_DELETION`,`DEMO`
expiresAt	date-time	Expiration date of customer data
partiallyExpiresAt	date-time	Partial expiration date of customer data
isAnonymized	boolean	Indicates if the customer has been anonymized after expiration
createdAt	string	Creation date of the customer
updatedAt	string	Last date of update of the customer
usage	string	Usage type of the customer: Business or Consumer Enum: `CONSUMER`,`BUSINESS`
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Personal information about the business customer

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

 
{ "id": "{string}", "customIdentifier": "{string}", "aggregationDetails": {  "userId": "{string}",  "aggregatorName": "{string}",  "callbackUrl": "{string}",  "token": "{string}",  "mode": "{string}",  "redirectUrl": "{string}",  "apiUrl": "{string}",  "iframeUrl": "{string}",  "clientId": "{string}" }, "connect": {  "serviceAccountClientId": "{string}" }, "dashboard": {  "currentState": "{string}",  "historyState": [   {    "createdAt": "{string}",    "state": "{string}",    "userId": "{string}"   }  ],  "invitationHistory": [   {    "date": "{string}",    "type": "{string}",    "channel": "{string}",    "senderUsername": "{string}"   }  ],  "numberOfViews": "{number}",  "numberOfAnalyses": "{number}",  "newWithAnalysis": "{boolean}",  "onboarding": {},  "team": "{string}",  "customizedMonthlyAmount": "{number}",  "analysesConfig": {},  "comments": [   {    "value": "{string}",    "authorEmail": "{string}",    "createdAt": "{date-time}",    "updatedAt": "{date-time}"   }  ],  "createdAt": "{string}",  "updatedAt": "{string}" }, "openBankingInformation": {  "owners": [   {    "name": "{string}"   }  ] }, "reports": {  "completedAnalyses": {   "count": "{number}",   "date": "{string}",   "url": "{string}"  },  "lastFailedAnalysis": {   "date": "{string}",   "url": "{string}",   "type": "{string}"  },  "userJourneyState": "{string}",  "pdfProcessingState": "{string}" }, "owner": {  "organizationId": "{string}",  "projectId": "{string}",  "projectName": "{string}" }, "shares": [  {   "organizationId": "{string}",   "projectId": "{string}",   "sharedAt": "{string}"  } ], "storage": {  "type": "{string}",  "expiresAt": "{date-time}",  "partiallyExpiresAt": "{date-time}",  "isAnonymized": "{boolean}" }, "createdAt": "{string}", "updatedAt": "{string}", "usage": "{string}", "userSegment": "{string}", "businessDetails": {}}
Copy

Update a single business based on a single ID

Auth

Path Params

businessId

string

The business id

Request Body

object	object
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Business details of the business

PATCH /v2/businesses/{businessId}

 
curl --request PATCH \ --url 'https://api.algoan.com/v2/businesses/{businessId}' \ --header 'Authorization: Bearer {token}' \ --data '{  "aggregationDetails": {    "userId": "{string}",    "aggregatorName": "{string}",    "callbackUrl": "{string}",    "token": "{string}",    "mode": "{string}",    "redirectUrl": "{string}",    "apiUrl": "{string}",    "iframeUrl": "{string}",    "clientId": "{string}"  },  "userSegment": "{string}",  "businessDetails": {}}'
Copy

Responses

200

object	object
id	string	Id of the customer
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
connect	object	Properties of the customer for the Connect product Deprecated
serviceAccountClientId	string	Client Id of the corresponding service account
dashboard13 fields	object	Dashboard Property of the customer for the new dashboard. Only present if the project contains the dashboard product.
currentState	string	Current state of the customer's report Enum: `NEW`,`VIEWED`,`ARCHIVED`
historyState3 fields	array[object]	States history: represents an array containing the history of the customer's report
createdAt	string	The date the state was created at
state	string	State of this report Enum: `NEW`,`VIEWED`,`ARCHIVED`
userId	string	User that consulted the dashboard and changed the report state
invitationHistory4 fields	array[object]	Invitation history: represents an array containing the history of the customer's invitations
date	string	The date of the event
type	string	type of the event Enum: `invitation_link_sent`,`invitation_link_retrieved`,`invitation_link_created`
channel	string	Channel of the invitation email or sms Enum: `email`,`sms`
senderUsername	string	The username of the sender
numberOfViews	number	Number of times the report was viewed
numberOfAnalyses	number	Number of COMPLETED analyses linked to the customer Deprecated
newWithAnalysis	boolean	New with analysis
onboarding	object	New with analysis
team	string	Team corresponding to the customer's dashboard
customizedMonthlyAmount	number	Monthly amount set by customer
analysesConfig	object	Analyses config of the customer: 1st string key of the map is an analysis Id 2st string key of the map is a cash flow Id
*	object
*	object
isIncludedInRemainderToLive	boolean	Indicate if the cashflow is included in the calculation of remainder to live
comments4 fields	array[object]	Customer comments
value	string	Value of the comment
authorEmail	string	Electronic mail address of comment author
createdAt	date-time	Creation date of the comment
updatedAt	date-time	Last update date of the comment
createdAt	string	Creation date
updatedAt	string	Last update date
openBankingInformation	object	Information about the customer retrieved from open banking
owners	array[object]	Account owners information
name	string	Name of the owner of the account
reports4 fields	object	Reported information about customer's analyses
completedAnalyses3 fields	object	Reported information about customer's completed analyses
count	number	Number of analyses completed linked to the customer
date	string	Date of the last analysis completed for the customer
url	string	URL of the last analysis completed for the customer
lastFailedAnalysis3 fields	object	Reported information about customer's last analysis in error
date	string	Date of the last analysis failed for the customer
url	string	URL of the last analysis failed for the customer
type	string	Type of the last analysis failed for the customer
userJourneyState	string	Reported information about customer's last state in the user journey Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
pdfProcessingState	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
owner3 fields	object	The organization and project where the customer belongs to originally
organizationId	string	The organization's id
projectId	string	The project's id
projectName	string	The project's name
shares3 fields	array[object]	The projects that the customer is shared with
organizationId	string	The organization's id
projectId	string	The project's id
sharedAt	string	The time of share
storage4 fields	object	Storage Properties of the customer
type	string	Type of storage when customer data is expired Enum: `DELETION`,`PARTIAL_DELETION`,`DEMO`
expiresAt	date-time	Expiration date of customer data
partiallyExpiresAt	date-time	Partial expiration date of customer data
isAnonymized	boolean	Indicates if the customer has been anonymized after expiration
createdAt	string	Creation date of the customer
updatedAt	string	Last date of update of the customer
usage	string	Usage type of the customer: Business or Consumer Enum: `CONSUMER`,`BUSINESS`
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Personal information about the business customer

400

Validation failed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

 
{ "id": "{string}", "customIdentifier": "{string}", "aggregationDetails": {  "userId": "{string}",  "aggregatorName": "{string}",  "callbackUrl": "{string}",  "token": "{string}",  "mode": "{string}",  "redirectUrl": "{string}",  "apiUrl": "{string}",  "iframeUrl": "{string}",  "clientId": "{string}" }, "connect": {  "serviceAccountClientId": "{string}" }, "dashboard": {  "currentState": "{string}",  "historyState": [   {    "createdAt": "{string}",    "state": "{string}",    "userId": "{string}"   }  ],  "invitationHistory": [   {    "date": "{string}",    "type": "{string}",    "channel": "{string}",    "senderUsername": "{string}"   }  ],  "numberOfViews": "{number}",  "numberOfAnalyses": "{number}",  "newWithAnalysis": "{boolean}",  "onboarding": {},  "team": "{string}",  "customizedMonthlyAmount": "{number}",  "analysesConfig": {},  "comments": [   {    "value": "{string}",    "authorEmail": "{string}",    "createdAt": "{date-time}",    "updatedAt": "{date-time}"   }  ],  "createdAt": "{string}",  "updatedAt": "{string}" }, "openBankingInformation": {  "owners": [   {    "name": "{string}"   }  ] }, "reports": {  "completedAnalyses": {   "count": "{number}",   "date": "{string}",   "url": "{string}"  },  "lastFailedAnalysis": {   "date": "{string}",   "url": "{string}",   "type": "{string}"  },  "userJourneyState": "{string}",  "pdfProcessingState": "{string}" }, "owner": {  "organizationId": "{string}",  "projectId": "{string}",  "projectName": "{string}" }, "shares": [  {   "organizationId": "{string}",   "projectId": "{string}",   "sharedAt": "{string}"  } ], "storage": {  "type": "{string}",  "expiresAt": "{date-time}",  "partiallyExpiresAt": "{date-time}",  "isAnonymized": "{boolean}" }, "createdAt": "{string}", "updatedAt": "{string}", "usage": "{string}", "userSegment": "{string}", "businessDetails": {}}
Copy

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.

GET

/v2/businesses/{businessId}/analyses

POST

/v2/businesses/{businessId}/analyses

GET

/v2/businesses/{businessId}/analyses/{analysisId}

PATCH

/v2/businesses/{businessId}/analyses/{analysisId}

GET

/v2/businesses/{businessId}/analyses/{analysisId}/balances

POST

/v2/businesses/{businessId}/analyses/{analysisId}/trigger

Find all analysis by organization/project

Auth

Path Params

businessId

string

id of the related customer

GET /v2/businesses/{businessId}/analyses

 
curl --get \ --url 'https://api.algoan.com/v2/businesses/{businessId}/analyses' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
resources17 fields	array[object]
id	string	Id of the analysis
customerId	string	Customer id to which the analysis is related
sessionId	string	Session id to which the analysis is related
folderId	string	Folder id to which the analysis is related. Set when the analysis is created from PDF bank statements.
parameters5 fields	object	Parameters
disableScores	boolean	If set to true, the scores will not be computed during the analysis.
disableCreditInsights	boolean	If set to true, the credit insights will not be computed during the analysis.
useBalanceDate	boolean	If set to true, the analysis will use the balance date as the base of the analysis window instead of the transaction date.
launchReport	boolean	If set to true, the report will be launched at the end of the analysis. Otherwise, the report should be launched manually by calling the dedicated endpoint: POST /v2/customers/{customerId}/reports
period6 fields	object	Analysis window parameters
mode	string	The window / kind of period the analysis will be run on Enum: `DAYS`,`MONTHS`,`MONTHS_TRUNCATED`,`MONTHS_AND_CURRENT`,`CUSTOM_WINDOW`
numberOfDays	number	The length of the window in days necessary in DAYS configuration
numberOfMonths	number	The length of the window in months necessary in all MONTHS type configuration
customWindowDateRange4 fields	object	Custom window date range necessary in CUSTOM_WINDOW configuration
minDate	string	The start date of the custom window (inclusive)
maxDate	string	The end date of the custom window (inclusive)
minScoreDate	string	The minimum date for which a score is calculated (inclusive)
maxScoreDate	string	The maximum date for which a score is calculated (inclusive)
includeCheckingAccountsOnTruncateWindow	boolean	For the mode "MONTHS_TRUNCATED" only include only checking accounts transactions to truncate window if true
isComputedUsingProjectConfig	boolean	If set to true, the analysis has been computed using the project configuration. This means that the analysis window has been defined according to the project configuration and not according to the parameters sent in the request.
metadata18 fields	object	Metadata ObjectId
id	string	Id of the metadata
analysisId	string	analysis id to which the metadata is related
numberOfCheckings	number	Number of "Checking" accounts
numberOfSavings	number	Number of "Saving" accounts
numberOfLoans	number	Number of "Loan" accounts
numberOfConsumerLoans	number	Number of "Consumer Loan" accounts
numberOfCreditCard	number	Number of "Credit Card" accounts
creditInsights9 fields	object	Indicators about the Open Banking data used to compute the Credit Insights product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts
monthlyTransactionCount	number	Monthly mean number of transactions
firstTransactionDate	string	Date of the oldest transaction
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions
minWindowDate	string	First date of the analysis window
maxWindowDate	string	Last date of the analysis window
numberOfDaysInWindow	number	Number of days of the window of transactions used to compute the product
creditScore9 fields	object	Indicators about the Open Banking data used to compute the Credit Score product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts
monthlyTransactionCount	number	Monthly mean number of transactions
firstTransactionDate	string	Date of the oldest transaction
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions
minWindowDate	string	First date of the analysis window
maxWindowDate	string	Last date of the analysis window
numberOfDaysInWindow	number	Number of days of the window of transactions used to compute the product
paymentScore9 fields	object	Indicators about the Open Banking data used to compute the Payment Score product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts
monthlyTransactionCount	number	Monthly mean number of transactions
firstTransactionDate	string	Date of the oldest transaction
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions
minWindowDate	string	First date of the analysis window
maxWindowDate	string	Last date of the analysis window
numberOfDaysInWindow	number	Number of days of the window of transactions used to compute the product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction Deprecated
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts Deprecated
monthlyTransactionCount	number	Monthly mean number of transactions Deprecated
firstTransactionDate	string	Date of the oldest transaction Deprecated
calendar3 fields	array[object]	Number of days for each month Deprecated
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions Deprecated
referenceDate	string	Reference date of the analysis
activityScore4 fields	object	A score measuring the activity of all aggregated accounts of a bank user. This score might be used to filter out users who are not active enough or to indicate that we probably don't have access to the main account.
value	number	Grade between 1 and 100, from the less active account to the most active one.
activityLevel	string	Appreciation on the accounts activity. There is three modalities LOW (1-19), MEDIUM(10-49) and GOOD(50-100). We don't store this for the moment Enum: `LOW`,`MEDIUM`,`GOOD`
numberOfDaysInWindow	number	Number of days
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
creditInsights		Credit Insights ObjectId
object	object
id	string	Id of the score
analysisId	string	Analysis id to which the credit insights is related
createdAt	string	Creation date of the credit insights
updatedAt	string	Last update date
usage	string	Indicates usage type of the credit insights, either for consumer or business credit insights. Enum: `CONSUMER`,`BUSINESS`
version	string	Credit insight version
scores		Score ObjectId
object	object
id	string	Id of the score
analysisId	string	Analysis id to which the score is related
createdAt		Creation date of the score
string	string
updatedAt		Last update date
string	string
usage	string	Indicates usage type of the score, either for consumer or business score. Enum: `CONSUMER`,`BUSINESS`
source	string	Source Enum: `INTERNAL`,`CLIENT`,`CASH_FLOW_UPDATE`,`ACCOUNT_SELECTION_UPDATE`,`PERIOD_UPDATE`,`REFRESH`,`REFRESH_WITH_NEW_ACCOUNTS`,`PDF_UPDATE`
dataOrigin	string	Data origin Enum: `OPEN_BANKING`,`PDF`,`UNKNOWN`
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
status	string	Status Enum: `CREATED`,`FETCHING_DATA`,`IN_PROGRESS`,`PENDING`,`COMPLETED`,`ERROR`
error	object	Error
code	string
message	string
accounts23 fields	array[object]	List of account used to obtain the analysis
id	string	The account unique identifier
balance	number	Last known account balance
balanceDate	string	Date of the last known account balance
currency	string	Account's currency
type	string	Account's type Enum: `CHECKING`,`SAVINGS`,`LOAN`,`CREDIT_CARD`,`UNKNOWN`
usage	string	Purpose of the account Enum: `PROFESSIONAL`,`PERSONAL`,`UNKNOWN`
ownership	string	Relationship between the owner and the account. Enum: `ATTORNEY`,`CO_HOLDER`,`HOLDER`,`OTHER`
owners	array[object]	Owners of the account
name	string	Name of the owner of the account
iban	string
bic	string	BIC (Business Identifier Code) of the account's bank
name	string	Name the account taken from the bank's website
bank4 fields	object	Properties computed by Algoan
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
country	string	Code of the country of the account
coming	number	Amount of coming operations (not yet debited)
details2 fields	object	Details of the account
savings4 fields	object	Details specific about a saving account
type	string	Saving account's type Enum: `SHORT_TERM`,`LONG_TERM`,`UNKNOWN`
openedAt	string	Opening date of the saving account
maximumAmount	number	Maximum amount authorized for the saving account
interestRate	number	Interest rate of the saving account
loan9 fields	object	Details specific to a loan account
type	string	Loan's type Enum: `REVOLVING`,`PERSONAL`,`MORTGAGE`,`OTHER`
amount	number	Amount of the loan
startDate	string	Loan's start date
endDate	string	Loan's end date
duration	number	Number of months the loan will take
insuranceLabel	string	Label of the insurance
payment	number	Monthly amount debited to repay the loan if it is amortizable
remainingCapital	number	Remaining amount of the capital still to repay
interestRate	number	Interest rate of the loan
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
transactions13 fields	array[object]	Account's transaction list
id	string	ID of the transaction
accountId	string	Id of the account linked to the transaction on Algoan
dates	object	Dates associated with the transaction
debitedAt	string	Debit date as seen on the bank statement
bookedAt	string	Realization date of the transaction
description	string	Description of the transaction taken from the banks's website
amount	number	Transaction's amount (negative if debit)
currency	string	Transaction's currency
enrichments8 fields	object	Properties computed by Algoan
category		Category of the transaction
string	string	Enum: `ALLOWANCE`,`ALLOWANCE_FAMILY`,`ALLOWANCE_HOUSING`,`ALLOWANCE_UNEMPLOYMENT`,`ALLOWANCE_DISABILITY`,`ALLOWANCE_HEALTH`,`ALLOWANCE_INCOME_SUPPORT`,`STATE_SUBSIDY`,`GAMBLING_GAIN`,`RENTAL_INCOME`,`RECEIVED_ALIMONY`,`FREELANCE`,`WAGE`,`WAGE_BONUS`,`WAGE_SALARY_ADVANCE`,`WAGE_ADVANCE_PAYMENT`,`RETIREMENT_PENSION`,`REVERSIONARY_PENSION`,`DISSAVING`,`OTHER_ENTRY`
type	string	Nature of the transaction Enum: `CASH_DEPOSIT`,`CASH_WITHDRAWAL`,`CHECK_DEPOSIT`,`CHECK`,`INCOMING_TRANSFER`,`INCOMING_INTERNAL_TRANSFER`,`OUTGOING_TRANSFER`,`OUTGOING_INTERNAL_TRANSFER`,`CARD`,`CARD_REFUND`,`DIRECT_DEBIT`,`INCOMING_CARD`,`CREDIT`,`DEBIT`
isRejected	boolean	Indicates if the transaction has been rejected or not. Deprecated
counterPartId	string	Id of the counterpart if the transaction is or has been rejected. Deprecated
relatedTransactions11 fields	object	List of identifiers related to this transaction.
retryOf	string	Id corresponding to the transaction retried by this transaction Flexible link
retriedOn	string	Id of the transaction corresponding to the retry of this transaction Flexible link
rejectionOf	string	Id of the rejected transaction corresponding to this transaction Robust link
rejectedOn	string	Id of the transaction corresponding to the rejection of this one Robust link
transferOf	string	Id of the transferred transaction Robust link
transferedOn	string	Id of the transaction corresponding to the transfer of this one Robust link Deprecated
transferredOn	string	Id of the transaction corresponding to the transfer of this one Robust link
resetOf	string	Id of the reset transaction Robust link
resetOn	string	Id of the transaction this transaction is reset on Robust link
refundOf	string	Id of the transaction that is going to be refunded Robust link
refundedOn	string	Id of the refunded of the transaction Robust link
groupId	string	Group id of the transaction Deprecated
descriptionGroupId	string	Description of the transaction group id Deprecated
isInternationalTransfer	boolean	Indicates if the transaction is international or not
isComing	boolean	Indicates if the transaction will be debited in the future or not.
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
comment	string	Comment on the transaction
isNonAnalysed	boolean	Indicates if the transaction is non analysed in the case of the full months analysis configuration
createdAt	date-time	Creation date of the transaction in Algoan's database
updatedAt	date-time	Last update date of the transaction in Algoan's database
isMerged	boolean	Information about whether or not an account has been merged
number	string	Account's number
relatedAccountIds	array[string]	Account's related accounts
isComputed	boolean	Whether the account has been used to compute the analysis
createdAt	date-time	Creation date on Algoan side
updatedAt	date-time	Last update date on Algoan side
createdAt	date-time	Creation date of the analysis
updatedAt	date-time	Last update date of the analysis
dailyBalances	array[object]	Analysis's daily balances
date	string	Date of the balance
balance	number	Account balance for the specific date
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

400

Bad request if the pagination parameters are invalid

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

xxxxxxxxxx
 
{
 "resources": [...],
 "pagination": {...}
}
Copy

Create analysis add the accounts and trigger analysis calculation if not empty

Auth

Path Params

businessId

string

id of the related business

Request Body

analysis to create

object	object
accounts		Accounts Exists if the format is ALGOAN, Tink V2 or empty
array	array[object]
balance	number	Last known account balance
balanceDate	string	Date of the last known account balance
currency	string	Account's currency
type	string	Account's type Enum: `CHECKING`,`SAVINGS`,`LOAN`,`CREDIT_CARD`,`UNKNOWN`
usage	string	Purpose of the account Enum: `PROFESSIONAL`,`PERSONAL`,`UNKNOWN`
ownership	string	Relationship between the owner and the account Enum: `ATTORNEY`,`CO_HOLDER`,`HOLDER`,`OTHER`
owners	array[object]	Owners of the account
name	string	Name of the owner of the account
iban	string
bic	string	BIC (Business Identifier Code) of the account's bank
name	string	Name the account taken from the bank's website
bank4 fields	object	Properties computed by Algoan
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
country	string	Code of the country of the account
coming	number	Amount of coming operations (not yet debited)
details2 fields	object	Details of the account
savings4 fields	object	Details specific about a saving account
type	string	Saving account's type Enum: `SHORT_TERM`,`LONG_TERM`,`UNKNOWN`
openedAt	string	Opening date of the saving account
maximumAmount	number	Maximum amount authorized for the saving account
interestRate	number	Interest rate of the saving account
loan9 fields	object	Details specific to a loan account
type	string	Loan's type Enum: `REVOLVING`,`PERSONAL`,`MORTGAGE`,`OTHER`
amount	number	Amount of the loan
startDate	string	Loan's start date
endDate	string	Loan's end date
duration	number	Number of months the loan will take
insuranceLabel	string	Label of the insurance
payment	number	Monthly amount debited to repay the loan if it is amortizable
remainingCapital	number	Remaining amount of the capital still to repay
interestRate	number	Interest rate of the loan
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
transactions11 fields	array[object]	Account's transactions list
id	string	Id of the transaction
accountId	string	Id of the account linked to the transaction on Algoan
dates	object	Dates associated with the transaction
debitedAt	string	Debit date as seen on the bank statement
bookedAt	string	Realization date of the transaction
description	string	Description of the transaction taken from the banks's website
amount	number	Transaction's amount (negative if debit)
currency	string	Transaction's currency
enrichments8 fields	object	Properties computed by Algoan
category		Category of the transaction
string	string	Enum: `ALLOWANCE`,`ALLOWANCE_FAMILY`,`ALLOWANCE_HOUSING`,`ALLOWANCE_UNEMPLOYMENT`,`ALLOWANCE_DISABILITY`,`ALLOWANCE_HEALTH`,`ALLOWANCE_INCOME_SUPPORT`,`STATE_SUBSIDY`,`GAMBLING_GAIN`,`RENTAL_INCOME`,`RECEIVED_ALIMONY`,`FREELANCE`,`WAGE`,`WAGE_BONUS`,`WAGE_SALARY_ADVANCE`,`WAGE_ADVANCE_PAYMENT`,`RETIREMENT_PENSION`,`REVERSIONARY_PENSION`,`DISSAVING`,`OTHER_ENTRY`
type	string	Nature of the transaction Enum: `CASH_DEPOSIT`,`CASH_WITHDRAWAL`,`CHECK_DEPOSIT`,`CHECK`,`INCOMING_TRANSFER`,`INCOMING_INTERNAL_TRANSFER`,`OUTGOING_TRANSFER`,`OUTGOING_INTERNAL_TRANSFER`,`CARD`,`CARD_REFUND`,`DIRECT_DEBIT`,`INCOMING_CARD`,`CREDIT`,`DEBIT`
isRejected	boolean	Indicates if the transaction has been rejected or not. Deprecated
counterPartId	string	Id of the counterpart if the transaction is or has been rejected. Deprecated
relatedTransactions11 fields	object	List of identifiers related to this transaction.
retryOf	string	Id corresponding to the transaction retried by this transaction Flexible link
retriedOn	string	Id of the transaction corresponding to the retry of this transaction Flexible link
rejectionOf	string	Id of the rejected transaction corresponding to this transaction Robust link
rejectedOn	string	Id of the transaction corresponding to the rejection of this one Robust link
transferOf	string	Id of the transferred transaction Robust link
transferedOn	string	Id of the transaction corresponding to the transfer of this one Robust link Deprecated
transferredOn	string	Id of the transaction corresponding to the transfer of this one Robust link
resetOf	string	Id of the reset transaction Robust link
resetOn	string	Id of the transaction this transaction is reset on Robust link
refundOf	string	Id of the transaction that is going to be refunded Robust link
refundedOn	string	Id of the refunded of the transaction Robust link
groupId	string	Group id of the transaction Deprecated
descriptionGroupId	string	Description of the transaction group id Deprecated
isInternationalTransfer	boolean	Indicates if the transaction is international or not
isComing	boolean	Indicates if the transaction will be debited in the future or not.
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
comment	string	Comment on the transaction
isNonAnalysed	boolean	Indicates if the transaction is non analysed in the case of the full months analysis configuration
dailyBalances	array[object]	Account's daily balances
date	string	Date of the balance
balance	number	Account balance for the specific date
isComputed	boolean	Whether the account will be used to compute the analysis
number	string	Account's number
connections		Budget Insight or Oxlin connections Exists if the format is BUDGET_INSIGHT_V2_0, or OXLIN_DIRECT_ACCOUNT_API or OXLIN_DIRECT_ACCOUNT_API_NEW
array	array
connection_type	string	Discriminator field filled by mongoose Enum: `budget-insight`,`linxo`,`oxlin-account-api`,`oxlin-direct-account-api`,`oxlin-new-direct-account-api`,`powens`,`unexpected`
id	number
id_user	number
id_connector	number
id_provider	number
id_bank	number
last_update	string
state	string	Enum: `wrongpass`,`additionalInformationNeeded`,`websiteUnavailable`,`actionNeeded`,`bug`,`SCARequired`,`decoupled`,`passwordExpired`,`webauthRequired`
active	boolean
created	string
next_try	string
error_message	string
last_push	string
expire	string
connector_uuid	string
connector15 fields	object
id	number
uuid	string
name	string
hidden	boolean
charged	boolean
code	string
beta	boolean
color	string
slug	string
sync_frequency	number
months_to_fetch	number
auth_mecanism	string
transfer_mecanism	string
siret	string
logoUrl	string
accounts28 fields	array[object]
id	number
id_connection	number
id_user	number
id_source	number
id_parent	number
number	string
webid	string
original_name	string
coming	number
bookmarked	number
display	boolean
deleted	string
currency4 fields	object
id	string
name	string
symbol	string
precision	number
balance	number
error	string
name	string
last_update	string
type	string	Enum: `article83`,`capitalisation`,`card`,`checking`,`consumercredit`,`crowdlending`,`deposit`,`joint`,`lifeinsurance`,`loan`,`madelin`,`market`,`mortgage`,`pea`,`pee`,`per`,`perco`,`perp`,`real_estate`,`rsp`,`savings`,`unknown`,`csl`,`livret_a`,`ldds`,`revolvingcredit`,`cel`,`pel`
id_type	number
iban	string
bic	string
loan19 fields	object
duration	number
insurance_label	string
total_amount	number
available_amount	number
used_amount	number
id	number
id_account	number
maturity_date	string
rate	number
next_payment_amount	number
nb_payments_left	number
nb_payments_done	number
nb_payments_total	number
last_payment_amount	number
next_payment_date	string
last_payment_date	string
subscription_date	string
type	string	Enum: `mortgage`,`consumercredit`,`revolvingcredit`
account_label	string
usage	string	Enum: `PRIV`,`ORGA`,`ASSO`
disabled	string
company_name	string
transactions37 fields	array[object]
id_account	number
id	number
application_date	string
date	string
dateTime	string
rdate	string
vdate	string
vdatetime	string
bdate	string
bdatetime	string
rdatetime	string
simplified_wording	string
stemmed_wording	string
formatted_value	string
state	string
value	number
gross_value	number
card	string
wording	string
original_wording	string
type	string
id_category	number
original_currency4 fields	object
id	string
name	string
symbol	string
precision	number
coming	boolean
active	boolean
category7 fields	object
id	number
id_parent_category	number
name	string
color	string
income	boolean
refundable	boolean
id_logo	number
date_scraped	string
last_update	string
deleted	string
id_cluster	number
commission	number
original_value	number
original_gross_value	number
comment	string
commission_currency4 fields	object
id	string
name	string
symbol	string
precision	number
country	string
webid	string
ownership	string	Enum: `owner`,`co-owner`,`attorney`
opening_date	string
information1 field	object
owner12 fields	object
name	string
first_name	string
last_name	string
company_name	string
job	string
job_start_date	string
socioprofessional_category	string
family_situation	string
housing_status	string
phone	string
email	string
postal_address	object
full_address	string
accountOwnerships		Budget Insight or Powens account ownerships
array	array[object]
id_account	number	ID of the related account
id_connection	number	ID of the related connection
id_user	number	ID of the related user
id_connector_source	number	ID of the related connector source
name	string	Name of the bank account
usage	string	Usage of the bank account Enum: `PRIV`,`ORGA`
parties2 fields	array[object]	List of account parties
role	string	Role of the party string Enum: `holder`,`co_holder`,`attorney`,`custodian_for_minor`,`legal_guardian`,`nominee`,`successor_on_death`,`trustee`,`unknown`
identity	object	Identity of the party object
is_user	boolean	Whether this account party represents the PSU, holder of the connection. It is null when it is not possible to verify this relation
full_name	string	Full name of the account party
identifications	array[object]	List of account identifications
scheme_name	string	Name of the account scheme type Enum: `iban`,`bban`,`sort_code_account_number`,`tpan`,`cpan`,`bank_party_identification`
identification	string	Identification number of the account
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
parameters5 fields	object	Parameters
disableScores	boolean	If set to true, the scores will not be computed during the analysis.
disableCreditInsights	boolean	If set to true, the credit insights will not be computed during the analysis.
useBalanceDate	boolean	If set to true, the analysis will use the balance date as the base of the analysis window instead of the transaction date.
launchReport	boolean	If set to true, the report will be launched at the end of the analysis. Otherwise, the report should be launched manually by calling the dedicated endpoint: POST /v2/customers/{customerId}/reports
period6 fields	object	Analysis window parameters
mode	string	The window / kind of period the analysis will be run on Enum: `DAYS`,`MONTHS`,`MONTHS_TRUNCATED`,`MONTHS_AND_CURRENT`,`CUSTOM_WINDOW`
numberOfDays	number	The length of the window in days necessary in DAYS configuration
numberOfMonths	number	The length of the window in months necessary in all MONTHS type configuration
customWindowDateRange4 fields	object	Custom window date range necessary in CUSTOM_WINDOW configuration
minDate	string	The start date of the custom window (inclusive)
maxDate	string	The end date of the custom window (inclusive)
minScoreDate	string	The minimum date for which a score is calculated (inclusive)
maxScoreDate	string	The maximum date for which a score is calculated (inclusive)
includeCheckingAccountsOnTruncateWindow	boolean	For the mode "MONTHS_TRUNCATED" only include only checking accounts transactions to truncate window if true
isComputedUsingProjectConfig	boolean	If set to true, the analysis has been computed using the project configuration. This means that the analysis window has been defined according to the project configuration and not according to the parameters sent in the request.
triggerAccountSync	boolean	Trigger account synchronization by emitting an event refresh or bank_details_required If not defined, the account synchronization will be triggered if there is no account in the body of the analysis
aggregatorConfigs	object	Parameters
temporaryCode	string
dataOrigin	string	Data origin Enum: `OPEN_BANKING`,`PDF`,`UNKNOWN`
projectId	string	In case there is more than one projectId in the identifier We create the analysis with this projectId We check that the projectId is included in the identifier
organizationId	string	In case there is more than one organizationId in the identifier We create the analysis with this organizationId We check that the organizationId is included in the identifier
sessionId	string	Id of the session to which the analysis is linked

POST /v2/businesses/{businessId}/analyses

Responses

201

Created

object	object
id	string	Id of the analysis
customerId	string	Customer id to which the analysis is related
sessionId	string	Session id to which the analysis is related
folderId	string	Folder id to which the analysis is related. Set when the analysis is created from PDF bank statements.
parameters5 fields	object	Parameters
disableScores	boolean	If set to true, the scores will not be computed during the analysis.
disableCreditInsights	boolean	If set to true, the credit insights will not be computed during the analysis.
useBalanceDate	boolean	If set to true, the analysis will use the balance date as the base of the analysis window instead of the transaction date.
launchReport	boolean	If set to true, the report will be launched at the end of the analysis. Otherwise, the report should be launched manually by calling the dedicated endpoint: POST /v2/customers/{customerId}/reports
period6 fields	object	Analysis window parameters
mode	string	The window / kind of period the analysis will be run on Enum: `DAYS`,`MONTHS`,`MONTHS_TRUNCATED`,`MONTHS_AND_CURRENT`,`CUSTOM_WINDOW`
numberOfDays	number	The length of the window in days necessary in DAYS configuration
numberOfMonths	number	The length of the window in months necessary in all MONTHS type configuration
customWindowDateRange4 fields	object	Custom window date range necessary in CUSTOM_WINDOW configuration
minDate	string	The start date of the custom window (inclusive)
maxDate	string	The end date of the custom window (inclusive)
minScoreDate	string	The minimum date for which a score is calculated (inclusive)
maxScoreDate	string	The maximum date for which a score is calculated (inclusive)
includeCheckingAccountsOnTruncateWindow	boolean	For the mode "MONTHS_TRUNCATED" only include only checking accounts transactions to truncate window if true
isComputedUsingProjectConfig	boolean	If set to true, the analysis has been computed using the project configuration. This means that the analysis window has been defined according to the project configuration and not according to the parameters sent in the request.
createdAt	date-time	Creation date of the analysis
updatedAt	date-time	Last update date of the analysis
error	object	Error
code	string
message	string
source	string	Source Enum: `INTERNAL`,`CLIENT`,`CASH_FLOW_UPDATE`,`ACCOUNT_SELECTION_UPDATE`,`PERIOD_UPDATE`,`REFRESH`,`REFRESH_WITH_NEW_ACCOUNTS`,`PDF_UPDATE`
dataOrigin	string	Data origin Enum: `OPEN_BANKING`,`PDF`,`UNKNOWN`
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
status	string	Status Enum: `CREATED`,`FETCHING_DATA`,`IN_PROGRESS`,`PENDING`,`COMPLETED`,`ERROR`

400

Validation failed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Find an analysis by id

Auth

Path Params

businessId	string	id of the related customer
analysisId	string	id of the analysis

GET /v2/businesses/{businessId}/analyses/{analysisId}

Responses

200

object	object
id	string	Id of the analysis
customerId	string	Customer id to which the analysis is related
sessionId	string	Session id to which the analysis is related
folderId	string	Folder id to which the analysis is related. Set when the analysis is created from PDF bank statements.
parameters5 fields	object	Parameters
disableScores	boolean	If set to true, the scores will not be computed during the analysis.
disableCreditInsights	boolean	If set to true, the credit insights will not be computed during the analysis.
useBalanceDate	boolean	If set to true, the analysis will use the balance date as the base of the analysis window instead of the transaction date.
launchReport	boolean	If set to true, the report will be launched at the end of the analysis. Otherwise, the report should be launched manually by calling the dedicated endpoint: POST /v2/customers/{customerId}/reports
period6 fields	object	Analysis window parameters
mode	string	The window / kind of period the analysis will be run on Enum: `DAYS`,`MONTHS`,`MONTHS_TRUNCATED`,`MONTHS_AND_CURRENT`,`CUSTOM_WINDOW`
numberOfDays	number	The length of the window in days necessary in DAYS configuration
numberOfMonths	number	The length of the window in months necessary in all MONTHS type configuration
customWindowDateRange4 fields	object	Custom window date range necessary in CUSTOM_WINDOW configuration
minDate	string	The start date of the custom window (inclusive)
maxDate	string	The end date of the custom window (inclusive)
minScoreDate	string	The minimum date for which a score is calculated (inclusive)
maxScoreDate	string	The maximum date for which a score is calculated (inclusive)
includeCheckingAccountsOnTruncateWindow	boolean	For the mode "MONTHS_TRUNCATED" only include only checking accounts transactions to truncate window if true
isComputedUsingProjectConfig	boolean	If set to true, the analysis has been computed using the project configuration. This means that the analysis window has been defined according to the project configuration and not according to the parameters sent in the request.
metadata18 fields	object	Metadata ObjectId
id	string	Id of the metadata
analysisId	string	analysis id to which the metadata is related
numberOfCheckings	number	Number of "Checking" accounts
numberOfSavings	number	Number of "Saving" accounts
numberOfLoans	number	Number of "Loan" accounts
numberOfConsumerLoans	number	Number of "Consumer Loan" accounts
numberOfCreditCard	number	Number of "Credit Card" accounts
creditInsights9 fields	object	Indicators about the Open Banking data used to compute the Credit Insights product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts
monthlyTransactionCount	number	Monthly mean number of transactions
firstTransactionDate	string	Date of the oldest transaction
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions
minWindowDate	string	First date of the analysis window
maxWindowDate	string	Last date of the analysis window
numberOfDaysInWindow	number	Number of days of the window of transactions used to compute the product
creditScore9 fields	object	Indicators about the Open Banking data used to compute the Credit Score product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts
monthlyTransactionCount	number	Monthly mean number of transactions
firstTransactionDate	string	Date of the oldest transaction
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions
minWindowDate	string	First date of the analysis window
maxWindowDate	string	Last date of the analysis window
numberOfDaysInWindow	number	Number of days of the window of transactions used to compute the product
paymentScore9 fields	object	Indicators about the Open Banking data used to compute the Payment Score product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts
monthlyTransactionCount	number	Monthly mean number of transactions
firstTransactionDate	string	Date of the oldest transaction
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions
minWindowDate	string	First date of the analysis window
maxWindowDate	string	Last date of the analysis window
numberOfDaysInWindow	number	Number of days of the window of transactions used to compute the product
lastTransactionGap	number	Number of days between the call to Score and Credit Insights and the last transaction Deprecated
historicalDepth	number	Number of days between the first and last transaction on the intersection of CHECKING accounts Deprecated
monthlyTransactionCount	number	Monthly mean number of transactions Deprecated
firstTransactionDate	string	Date of the oldest transaction Deprecated
calendar3 fields	array[object]	Number of days for each month Deprecated
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
totalTransactionCount	number	Total number of analysed transactions Deprecated
referenceDate	string	Reference date of the analysis
activityScore4 fields	object	A score measuring the activity of all aggregated accounts of a bank user. This score might be used to filter out users who are not active enough or to indicate that we probably don't have access to the main account.
value	number	Grade between 1 and 100, from the less active account to the most active one.
activityLevel	string	Appreciation on the accounts activity. There is three modalities LOW (1-19), MEDIUM(10-49) and GOOD(50-100). We don't store this for the moment Enum: `LOW`,`MEDIUM`,`GOOD`
numberOfDaysInWindow	number	Number of days
calendar3 fields	array[object]	Number of days for each month
month	string	Calendar month of the transaction
amount	number	Amount, negative if expense, positive if income.
nbDays	number	Number of days of the month covered in the banking history.
creditInsights		Credit Insights ObjectId
object	object
id	string	Id of the score
analysisId	string	Analysis id to which the credit insights is related
createdAt	string	Creation date of the credit insights
updatedAt	string	Last update date
usage	string	Indicates usage type of the credit insights, either for consumer or business credit insights. Enum: `CONSUMER`,`BUSINESS`
version	string	Credit insight version
scores		Score ObjectId
object	object
id	string	Id of the score
analysisId	string	Analysis id to which the score is related
createdAt		Creation date of the score
string	string
updatedAt		Last update date
string	string
usage	string	Indicates usage type of the score, either for consumer or business score. Enum: `CONSUMER`,`BUSINESS`
source	string	Source Enum: `INTERNAL`,`CLIENT`,`CASH_FLOW_UPDATE`,`ACCOUNT_SELECTION_UPDATE`,`PERIOD_UPDATE`,`REFRESH`,`REFRESH_WITH_NEW_ACCOUNTS`,`PDF_UPDATE`
dataOrigin	string	Data origin Enum: `OPEN_BANKING`,`PDF`,`UNKNOWN`
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
status	string	Status Enum: `CREATED`,`FETCHING_DATA`,`IN_PROGRESS`,`PENDING`,`COMPLETED`,`ERROR`
error	object	Error
code	string
message	string
accounts23 fields	array[object]	List of account used to obtain the analysis
id	string	The account unique identifier
balance	number	Last known account balance
balanceDate	string	Date of the last known account balance
currency	string	Account's currency
type	string	Account's type Enum: `CHECKING`,`SAVINGS`,`LOAN`,`CREDIT_CARD`,`UNKNOWN`
usage	string	Purpose of the account Enum: `PROFESSIONAL`,`PERSONAL`,`UNKNOWN`
ownership	string	Relationship between the owner and the account. Enum: `ATTORNEY`,`CO_HOLDER`,`HOLDER`,`OTHER`
owners	array[object]	Owners of the account
name	string	Name of the owner of the account
iban	string
bic	string	BIC (Business Identifier Code) of the account's bank
name	string	Name the account taken from the bank's website
bank4 fields	object	Properties computed by Algoan
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
country	string	Code of the country of the account
coming	number	Amount of coming operations (not yet debited)
details2 fields	object	Details of the account
savings4 fields	object	Details specific about a saving account
type	string	Saving account's type Enum: `SHORT_TERM`,`LONG_TERM`,`UNKNOWN`
openedAt	string	Opening date of the saving account
maximumAmount	number	Maximum amount authorized for the saving account
interestRate	number	Interest rate of the saving account
loan9 fields	object	Details specific to a loan account
type	string	Loan's type Enum: `REVOLVING`,`PERSONAL`,`MORTGAGE`,`OTHER`
amount	number	Amount of the loan
startDate	string	Loan's start date
endDate	string	Loan's end date
duration	number	Number of months the loan will take
insuranceLabel	string	Label of the insurance
payment	number	Monthly amount debited to repay the loan if it is amortizable
remainingCapital	number	Remaining amount of the capital still to repay
interestRate	number	Interest rate of the loan
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
transactions13 fields	array[object]	Account's transaction list
id	string	ID of the transaction
accountId	string	Id of the account linked to the transaction on Algoan
dates	object	Dates associated with the transaction
debitedAt	string	Debit date as seen on the bank statement
bookedAt	string	Realization date of the transaction
description	string	Description of the transaction taken from the banks's website
amount	number	Transaction's amount (negative if debit)
currency	string	Transaction's currency
enrichments8 fields	object	Properties computed by Algoan
category		Category of the transaction
string	string	Enum: `ALLOWANCE`,`ALLOWANCE_FAMILY`,`ALLOWANCE_HOUSING`,`ALLOWANCE_UNEMPLOYMENT`,`ALLOWANCE_DISABILITY`,`ALLOWANCE_HEALTH`,`ALLOWANCE_INCOME_SUPPORT`,`STATE_SUBSIDY`,`GAMBLING_GAIN`,`RENTAL_INCOME`,`RECEIVED_ALIMONY`,`FREELANCE`,`WAGE`,`WAGE_BONUS`,`WAGE_SALARY_ADVANCE`,`WAGE_ADVANCE_PAYMENT`,`RETIREMENT_PENSION`,`REVERSIONARY_PENSION`,`DISSAVING`,`OTHER_ENTRY`
type	string	Nature of the transaction Enum: `CASH_DEPOSIT`,`CASH_WITHDRAWAL`,`CHECK_DEPOSIT`,`CHECK`,`INCOMING_TRANSFER`,`INCOMING_INTERNAL_TRANSFER`,`OUTGOING_TRANSFER`,`OUTGOING_INTERNAL_TRANSFER`,`CARD`,`CARD_REFUND`,`DIRECT_DEBIT`,`INCOMING_CARD`,`CREDIT`,`DEBIT`
isRejected	boolean	Indicates if the transaction has been rejected or not. Deprecated
counterPartId	string	Id of the counterpart if the transaction is or has been rejected. Deprecated
relatedTransactions11 fields	object	List of identifiers related to this transaction.
retryOf	string	Id corresponding to the transaction retried by this transaction Flexible link
retriedOn	string	Id of the transaction corresponding to the retry of this transaction Flexible link
rejectionOf	string	Id of the rejected transaction corresponding to this transaction Robust link
rejectedOn	string	Id of the transaction corresponding to the rejection of this one Robust link
transferOf	string	Id of the transferred transaction Robust link
transferedOn	string	Id of the transaction corresponding to the transfer of this one Robust link Deprecated
transferredOn	string	Id of the transaction corresponding to the transfer of this one Robust link
resetOf	string	Id of the reset transaction Robust link
resetOn	string	Id of the transaction this transaction is reset on Robust link
refundOf	string	Id of the transaction that is going to be refunded Robust link
refundedOn	string	Id of the refunded of the transaction Robust link
groupId	string	Group id of the transaction Deprecated
descriptionGroupId	string	Description of the transaction group id Deprecated
isInternationalTransfer	boolean	Indicates if the transaction is international or not
isComing	boolean	Indicates if the transaction will be debited in the future or not.
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
comment	string	Comment on the transaction
isNonAnalysed	boolean	Indicates if the transaction is non analysed in the case of the full months analysis configuration
createdAt	date-time	Creation date of the transaction in Algoan's database
updatedAt	date-time	Last update date of the transaction in Algoan's database
isMerged	boolean	Information about whether or not an account has been merged
number	string	Account's number
relatedAccountIds	array[string]	Account's related accounts
isComputed	boolean	Whether the account has been used to compute the analysis
createdAt	date-time	Creation date on Algoan side
updatedAt	date-time	Last update date on Algoan side
createdAt	date-time	Creation date of the analysis
updatedAt	date-time	Last update date of the analysis
dailyBalances	array[object]	Analysis's daily balances
date	string	Date of the balance
balance	number	Account balance for the specific date

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Update analysis: add the accounts and trigger analysis computation

Auth

Path Params

businessId	string	id of the related business
analysisId	string	id of the analysis to update

Request Body

analysis updates

object	object
accounts		Accounts Exists if the format is ALGOAN, Tink V2 or empty
array	array[object]
balance	number	Last known account balance
balanceDate	string	Date of the last known account balance
currency	string	Account's currency
type	string	Account's type Enum: `CHECKING`,`SAVINGS`,`LOAN`,`CREDIT_CARD`,`UNKNOWN`
usage	string	Purpose of the account Enum: `PROFESSIONAL`,`PERSONAL`,`UNKNOWN`
ownership	string	Relationship between the owner and the account Enum: `ATTORNEY`,`CO_HOLDER`,`HOLDER`,`OTHER`
owners	array[object]	Owners of the account
name	string	Name of the owner of the account
iban	string
bic	string	BIC (Business Identifier Code) of the account's bank
name	string	Name the account taken from the bank's website
bank4 fields	object	Properties computed by Algoan
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
country	string	Code of the country of the account
coming	number	Amount of coming operations (not yet debited)
details2 fields	object	Details of the account
savings4 fields	object	Details specific about a saving account
type	string	Saving account's type Enum: `SHORT_TERM`,`LONG_TERM`,`UNKNOWN`
openedAt	string	Opening date of the saving account
maximumAmount	number	Maximum amount authorized for the saving account
interestRate	number	Interest rate of the saving account
loan9 fields	object	Details specific to a loan account
type	string	Loan's type Enum: `REVOLVING`,`PERSONAL`,`MORTGAGE`,`OTHER`
amount	number	Amount of the loan
startDate	string	Loan's start date
endDate	string	Loan's end date
duration	number	Number of months the loan will take
insuranceLabel	string	Label of the insurance
payment	number	Monthly amount debited to repay the loan if it is amortizable
remainingCapital	number	Remaining amount of the capital still to repay
interestRate	number	Interest rate of the loan
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
transactions11 fields	array[object]	Account's transactions list
id	string	Id of the transaction
accountId	string	Id of the account linked to the transaction on Algoan
dates	object	Dates associated with the transaction
debitedAt	string	Debit date as seen on the bank statement
bookedAt	string	Realization date of the transaction
description	string	Description of the transaction taken from the banks's website
amount	number	Transaction's amount (negative if debit)
currency	string	Transaction's currency
enrichments8 fields	object	Properties computed by Algoan
category		Category of the transaction
string	string	Enum: `ALLOWANCE`,`ALLOWANCE_FAMILY`,`ALLOWANCE_HOUSING`,`ALLOWANCE_UNEMPLOYMENT`,`ALLOWANCE_DISABILITY`,`ALLOWANCE_HEALTH`,`ALLOWANCE_INCOME_SUPPORT`,`STATE_SUBSIDY`,`GAMBLING_GAIN`,`RENTAL_INCOME`,`RECEIVED_ALIMONY`,`FREELANCE`,`WAGE`,`WAGE_BONUS`,`WAGE_SALARY_ADVANCE`,`WAGE_ADVANCE_PAYMENT`,`RETIREMENT_PENSION`,`REVERSIONARY_PENSION`,`DISSAVING`,`OTHER_ENTRY`
type	string	Nature of the transaction Enum: `CASH_DEPOSIT`,`CASH_WITHDRAWAL`,`CHECK_DEPOSIT`,`CHECK`,`INCOMING_TRANSFER`,`INCOMING_INTERNAL_TRANSFER`,`OUTGOING_TRANSFER`,`OUTGOING_INTERNAL_TRANSFER`,`CARD`,`CARD_REFUND`,`DIRECT_DEBIT`,`INCOMING_CARD`,`CREDIT`,`DEBIT`
isRejected	boolean	Indicates if the transaction has been rejected or not. Deprecated
counterPartId	string	Id of the counterpart if the transaction is or has been rejected. Deprecated
relatedTransactions11 fields	object	List of identifiers related to this transaction.
retryOf	string	Id corresponding to the transaction retried by this transaction Flexible link
retriedOn	string	Id of the transaction corresponding to the retry of this transaction Flexible link
rejectionOf	string	Id of the rejected transaction corresponding to this transaction Robust link
rejectedOn	string	Id of the transaction corresponding to the rejection of this one Robust link
transferOf	string	Id of the transferred transaction Robust link
transferedOn	string	Id of the transaction corresponding to the transfer of this one Robust link Deprecated
transferredOn	string	Id of the transaction corresponding to the transfer of this one Robust link
resetOf	string	Id of the reset transaction Robust link
resetOn	string	Id of the transaction this transaction is reset on Robust link
refundOf	string	Id of the transaction that is going to be refunded Robust link
refundedOn	string	Id of the refunded of the transaction Robust link
groupId	string	Group id of the transaction Deprecated
descriptionGroupId	string	Description of the transaction group id Deprecated
isInternationalTransfer	boolean	Indicates if the transaction is international or not
isComing	boolean	Indicates if the transaction will be debited in the future or not.
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
comment	string	Comment on the transaction
isNonAnalysed	boolean	Indicates if the transaction is non analysed in the case of the full months analysis configuration
dailyBalances	array[object]	Account's daily balances
date	string	Date of the balance
balance	number	Account balance for the specific date
isComputed	boolean	Whether the account will be used to compute the analysis
number	string	Account's number
connections		Budget Insight or Oxlin connections Exists if the format is BUDGET_INSIGHT_V2_0, or OXLIN_DIRECT_ACCOUNT_API or OXLIN_DIRECT_ACCOUNT_API_NEW
array	array
connection_type	string	Discriminator field filled by mongoose Enum: `budget-insight`,`linxo`,`oxlin-account-api`,`oxlin-direct-account-api`,`oxlin-new-direct-account-api`,`powens`,`unexpected`
id	number
id_user	number
id_connector	number
id_provider	number
id_bank	number
last_update	string
state	string	Enum: `wrongpass`,`additionalInformationNeeded`,`websiteUnavailable`,`actionNeeded`,`bug`,`SCARequired`,`decoupled`,`passwordExpired`,`webauthRequired`
active	boolean
created	string
next_try	string
error_message	string
last_push	string
expire	string
connector_uuid	string
connector15 fields	object
id	number
uuid	string
name	string
hidden	boolean
charged	boolean
code	string
beta	boolean
color	string
slug	string
sync_frequency	number
months_to_fetch	number
auth_mecanism	string
transfer_mecanism	string
siret	string
logoUrl	string
accounts28 fields	array[object]
id	number
id_connection	number
id_user	number
id_source	number
id_parent	number
number	string
webid	string
original_name	string
coming	number
bookmarked	number
display	boolean
deleted	string
currency4 fields	object
id	string
name	string
symbol	string
precision	number
balance	number
error	string
name	string
last_update	string
type	string	Enum: `article83`,`capitalisation`,`card`,`checking`,`consumercredit`,`crowdlending`,`deposit`,`joint`,`lifeinsurance`,`loan`,`madelin`,`market`,`mortgage`,`pea`,`pee`,`per`,`perco`,`perp`,`real_estate`,`rsp`,`savings`,`unknown`,`csl`,`livret_a`,`ldds`,`revolvingcredit`,`cel`,`pel`
id_type	number
iban	string
bic	string
loan19 fields	object
duration	number
insurance_label	string
total_amount	number
available_amount	number
used_amount	number
id	number
id_account	number
maturity_date	string
rate	number
next_payment_amount	number
nb_payments_left	number
nb_payments_done	number
nb_payments_total	number
last_payment_amount	number
next_payment_date	string
last_payment_date	string
subscription_date	string
type	string	Enum: `mortgage`,`consumercredit`,`revolvingcredit`
account_label	string
usage	string	Enum: `PRIV`,`ORGA`,`ASSO`
disabled	string
company_name	string
transactions37 fields	array[object]
id_account	number
id	number
application_date	string
date	string
dateTime	string
rdate	string
vdate	string
vdatetime	string
bdate	string
bdatetime	string
rdatetime	string
simplified_wording	string
stemmed_wording	string
formatted_value	string
state	string
value	number
gross_value	number
card	string
wording	string
original_wording	string
type	string
id_category	number
original_currency4 fields	object
id	string
name	string
symbol	string
precision	number
coming	boolean
active	boolean
category7 fields	object
id	number
id_parent_category	number
name	string
color	string
income	boolean
refundable	boolean
id_logo	number
date_scraped	string
last_update	string
deleted	string
id_cluster	number
commission	number
original_value	number
original_gross_value	number
comment	string
commission_currency4 fields	object
id	string
name	string
symbol	string
precision	number
country	string
webid	string
ownership	string	Enum: `owner`,`co-owner`,`attorney`
opening_date	string
information1 field	object
owner12 fields	object
name	string
first_name	string
last_name	string
company_name	string
job	string
job_start_date	string
socioprofessional_category	string
family_situation	string
housing_status	string
phone	string
email	string
postal_address	object
full_address	string
accountOwnerships		Budget Insight or Powens account ownerships
array	array[object]
id_account	number	ID of the related account
id_connection	number	ID of the related connection
id_user	number	ID of the related user
id_connector_source	number	ID of the related connector source
name	string	Name of the bank account
usage	string	Usage of the bank account Enum: `PRIV`,`ORGA`
parties2 fields	array[object]	List of account parties
role	string	Role of the party string Enum: `holder`,`co_holder`,`attorney`,`custodian_for_minor`,`legal_guardian`,`nominee`,`successor_on_death`,`trustee`,`unknown`
identity	object	Identity of the party object
is_user	boolean	Whether this account party represents the PSU, holder of the connection. It is null when it is not possible to verify this relation
full_name	string	Full name of the account party
identifications	array[object]	List of account identifications
scheme_name	string	Name of the account scheme type Enum: `iban`,`bban`,`sort_code_account_number`,`tpan`,`cpan`,`bank_party_identification`
identification	string	Identification number of the account
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
status	string	Status Enum: `CREATED`,`FETCHING_DATA`,`IN_PROGRESS`,`PENDING`,`COMPLETED`,`ERROR`
error	object	Error
code	string
message	string
trigger	boolean	Trigger the analysis If set to false, the call will only update the accounts You will need to call the route POST /analysis/{analysisId}/trigger to trigger the analysis afterwards

PATCH /v2/businesses/{businessId}/analyses/{analysisId}

Responses

200

object	object
id	string	Id of the analysis
customerId	string	Customer id to which the analysis is related
sessionId	string	Session id to which the analysis is related
folderId	string	Folder id to which the analysis is related. Set when the analysis is created from PDF bank statements.
parameters5 fields	object	Parameters
disableScores	boolean	If set to true, the scores will not be computed during the analysis.
disableCreditInsights	boolean	If set to true, the credit insights will not be computed during the analysis.
useBalanceDate	boolean	If set to true, the analysis will use the balance date as the base of the analysis window instead of the transaction date.
launchReport	boolean	If set to true, the report will be launched at the end of the analysis. Otherwise, the report should be launched manually by calling the dedicated endpoint: POST /v2/customers/{customerId}/reports
period6 fields	object	Analysis window parameters
mode	string	The window / kind of period the analysis will be run on Enum: `DAYS`,`MONTHS`,`MONTHS_TRUNCATED`,`MONTHS_AND_CURRENT`,`CUSTOM_WINDOW`
numberOfDays	number	The length of the window in days necessary in DAYS configuration
numberOfMonths	number	The length of the window in months necessary in all MONTHS type configuration
customWindowDateRange4 fields	object	Custom window date range necessary in CUSTOM_WINDOW configuration
minDate	string	The start date of the custom window (inclusive)
maxDate	string	The end date of the custom window (inclusive)
minScoreDate	string	The minimum date for which a score is calculated (inclusive)
maxScoreDate	string	The maximum date for which a score is calculated (inclusive)
includeCheckingAccountsOnTruncateWindow	boolean	For the mode "MONTHS_TRUNCATED" only include only checking accounts transactions to truncate window if true
isComputedUsingProjectConfig	boolean	If set to true, the analysis has been computed using the project configuration. This means that the analysis window has been defined according to the project configuration and not according to the parameters sent in the request.
createdAt	date-time	Creation date of the analysis
updatedAt	date-time	Last update date of the analysis
error	object	Error
code	string
message	string
source	string	Source Enum: `INTERNAL`,`CLIENT`,`CASH_FLOW_UPDATE`,`ACCOUNT_SELECTION_UPDATE`,`PERIOD_UPDATE`,`REFRESH`,`REFRESH_WITH_NEW_ACCOUNTS`,`PDF_UPDATE`
dataOrigin	string	Data origin Enum: `OPEN_BANKING`,`PDF`,`UNKNOWN`
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
status	string	Status Enum: `CREATED`,`FETCHING_DATA`,`IN_PROGRESS`,`PENDING`,`COMPLETED`,`ERROR`

400

Validation failed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Find daily balances linked to an analysis

Auth

Path Params

businessId	string	id of the related business
analysisId	string	id of the analysis

GET /v2/businesses/{businessId}/analyses/{analysisId}/balances

Responses

200

object	object
resources	array[object]
date	string	Date of the balance
balance	number	Account balance for the specific date
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

400

Bad request if the analysis is not completed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Trigger analysis computation

Auth

Path Params

businessId	string	id of the related business
analysisId	string	id of the analysis to update

Request Body

parameters to update

object	object
disableScores	boolean	Disable scores generation during the analysis
disableCreditInsights	boolean	Disable credit insights generation during the analysis

POST /v2/businesses/{businessId}/analyses/{analysisId}/trigger

Responses

201

Created

object	object
id	string	Id of the analysis
customerId	string	Customer id to which the analysis is related
sessionId	string	Session id to which the analysis is related
folderId	string	Folder id to which the analysis is related. Set when the analysis is created from PDF bank statements.
parameters5 fields	object	Parameters
disableScores	boolean	If set to true, the scores will not be computed during the analysis.
disableCreditInsights	boolean	If set to true, the credit insights will not be computed during the analysis.
useBalanceDate	boolean	If set to true, the analysis will use the balance date as the base of the analysis window instead of the transaction date.
launchReport	boolean	If set to true, the report will be launched at the end of the analysis. Otherwise, the report should be launched manually by calling the dedicated endpoint: POST /v2/customers/{customerId}/reports
period6 fields	object	Analysis window parameters
mode	string	The window / kind of period the analysis will be run on Enum: `DAYS`,`MONTHS`,`MONTHS_TRUNCATED`,`MONTHS_AND_CURRENT`,`CUSTOM_WINDOW`
numberOfDays	number	The length of the window in days necessary in DAYS configuration
numberOfMonths	number	The length of the window in months necessary in all MONTHS type configuration
customWindowDateRange4 fields	object	Custom window date range necessary in CUSTOM_WINDOW configuration
minDate	string	The start date of the custom window (inclusive)
maxDate	string	The end date of the custom window (inclusive)
minScoreDate	string	The minimum date for which a score is calculated (inclusive)
maxScoreDate	string	The maximum date for which a score is calculated (inclusive)
includeCheckingAccountsOnTruncateWindow	boolean	For the mode "MONTHS_TRUNCATED" only include only checking accounts transactions to truncate window if true
isComputedUsingProjectConfig	boolean	If set to true, the analysis has been computed using the project configuration. This means that the analysis window has been defined according to the project configuration and not according to the parameters sent in the request.
createdAt	date-time	Creation date of the analysis
updatedAt	date-time	Last update date of the analysis
error	object	Error
code	string
message	string
source	string	Source Enum: `INTERNAL`,`CLIENT`,`CASH_FLOW_UPDATE`,`ACCOUNT_SELECTION_UPDATE`,`PERIOD_UPDATE`,`REFRESH`,`REFRESH_WITH_NEW_ACCOUNTS`,`PDF_UPDATE`
dataOrigin	string	Data origin Enum: `OPEN_BANKING`,`PDF`,`UNKNOWN`
format	string	Original format of the open banking data Enum: `MASTERCARD_OPEN_BANKING_ENTERPRISE_V2`,`MASTERCARD_OPEN_BANKING`,`MASTERCARD_OPEN_FINANCE_DATA_V1`,`ALGOAN`,`BUDGET_INSIGHT_V2_0`,`POWENS_V2_1`,`LINXO_CONNECT_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_NEW_DIRECT_ACCOUNT_API_V3`,`LINXO_CONNECT_ACCOUNT_API_V2`,`TINK_V2`,`HYBRID`
status	string	Status Enum: `CREATED`,`FETCHING_DATA`,`IN_PROGRESS`,`PENDING`,`COMPLETED`,`ERROR`

400

Validation failed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Score

Score attached to the analysis

GET

/v2/businesses/{businessId}/analyses/{analysisId}/scores

Find an analysis by id and return only scores

Auth

Path Params

businessId	string	id of the related customer
analysisId	string	id of the analysis

GET /v2/businesses/{businessId}/analyses/{analysisId}/scores

Responses

200

object	object
id	string	Id of the score
analysisId	string	Analysis id to which the score is related
createdAt		Creation date of the score
string	string
updatedAt		Last update date
string	string
usage	string	Indicates usage type of the score, either for consumer or business score. Enum: `CONSUMER`,`BUSINESS`
businessCreditScore4 fields	object	Twelve month default score
version	string	Score's version
value	number	Between 0 and 1000. 0 is risky, 1000 is safe.
indicators3 fields	object	Business credit score indicators
cashFlowManagement	number	Cash flow management indicator
financialStability	number	Financial stability indicator
businessManagement	number	Business management indicator
monitoring6 fields	object	Business credit score monitoring data
regularExpensesCount	number
maxEvolution	number
last90dDaysAbove5000	number	Number of days with the 90 last with balance above 5000
urssafAmount	number
taxAmount	number
countRisky	number

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Account

Bank accounts attached to a customer

GET

/v2/businesses/{businessId}/analyses/{analysisId}/accounts

GET

/v2/businesses/{businessId}/analyses/{analysisId}/accounts/{accountId}/balances

Find all accounts linked to an analysis

Auth

Path Params

businessId	string	id of the related business
analysisId	string	id of the analysis

Query String

includeNotComputed boolean

GET /v2/businesses/{businessId}/analyses/{analysisId}/accounts

Responses

200

object	object
resources22 fields	array[object]
id	string	The account unique identifier
balance	number	Last known account balance
balanceDate	string	Date of the last known account balance
currency	string	Account's currency
type	string	Account's type Enum: `CHECKING`,`SAVINGS`,`LOAN`,`CREDIT_CARD`,`UNKNOWN`
usage	string	Purpose of the account Enum: `PROFESSIONAL`,`PERSONAL`,`UNKNOWN`
ownership	string	Relationship between the owner and the account. Enum: `ATTORNEY`,`CO_HOLDER`,`HOLDER`,`OTHER`
owners	array[object]	Owners of the account
name	string	Name of the owner of the account
iban	string
bic	string	BIC (Business Identifier Code) of the account's bank
name	string	Name the account taken from the bank's website
bank4 fields	object	Properties computed by Algoan
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
country	string	Code of the country of the account
coming	number	Amount of coming operations (not yet debited)
details2 fields	object	Details of the account
savings4 fields	object	Details specific about a saving account
type	string	Saving account's type Enum: `SHORT_TERM`,`LONG_TERM`,`UNKNOWN`
openedAt	string	Opening date of the saving account
maximumAmount	number	Maximum amount authorized for the saving account
interestRate	number	Interest rate of the saving account
loan9 fields	object	Details specific to a loan account
type	string	Loan's type Enum: `REVOLVING`,`PERSONAL`,`MORTGAGE`,`OTHER`
amount	number	Amount of the loan
startDate	string	Loan's start date
endDate	string	Loan's end date
duration	number	Number of months the loan will take
insuranceLabel	string	Label of the insurance
payment	number	Monthly amount debited to repay the loan if it is amortizable
remainingCapital	number	Remaining amount of the capital still to repay
interestRate	number	Interest rate of the loan
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
updatedAt	date-time	Last update date on Algoan side
isMerged	boolean	Information about whether or not an account has been merged
number	string	Account's number
relatedAccountIds	array[string]	Account's related accounts
isComputed	boolean	Whether the account has been used to compute the analysis
createdAt	date-time	Creation date on Algoan side
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

400

Bad Request

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Find all Daily Balances linked to an account from an analysis

Auth

Path Params

businessId	string	id of the related business
analysisId	string	id of the analysis
accountId	string	id of the account

GET /v2/businesses/{businessId}/analyses/{analysisId}/accounts/{accountId}/balances

Responses

200

object	object
resources	array[object]
date	string	Date of the balance
balance	number	Account balance for the specific date
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Transaction

Transactions attached to a Customer's bank account

GET

/v2/businesses/{businessId}/analyses/{analysisId}/accounts/{accountId}/transactions

GET

/v2/businesses/{businessId}/analyses/{analysisId}/transactions

Find all transactions linked to an account from an analysis

Auth

Path Params

businessId	string	id of the related business
analysisId	string	id of the analysis
accountId	string	id of the account

GET /v2/businesses/{businessId}/analyses/{analysisId}/accounts/{accountId}/transactions

Responses

200

object	object
resources	array
id	string	ID of the transaction
accountId	string	Id of the account linked to the transaction on Algoan
dates	object	Dates associated with the transaction
debitedAt	string	Debit date as seen on the bank statement
bookedAt	string	Realization date of the transaction
description	string	Description of the transaction taken from the banks's website
amount	number	Transaction's amount (negative if debit)
currency	string	Transaction's currency
updatedAt	date-time	Last update date of the transaction in Algoan's database
isComing	boolean	Indicates if the transaction will be debited in the future or not.
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
comment	string	Comment on the transaction
isNonAnalysed	boolean	Indicates if the transaction is non analysed in the case of the full months analysis configuration
createdAt	date-time	Creation date of the transaction in Algoan's database
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Find all transactions of an analysis

Auth

Path Params

businessId	string
analysisId	string	id of the analysis

GET /v2/businesses/{businessId}/analyses/{analysisId}/transactions

Responses

200

object	object
resources
object	object
id	string	ID of the transaction
accountId	string	Id of the account linked to the transaction on Algoan
dates	object	Dates associated with the transaction
debitedAt	string	Debit date as seen on the bank statement
bookedAt	string	Realization date of the transaction
description	string	Description of the transaction taken from the banks's website
amount	number	Transaction's amount (negative if debit)
currency	string	Transaction's currency
enrichments8 fields	object	Properties computed by Algoan
category		Category of the transaction
string	string	Enum: `ALLOWANCE`,`ALLOWANCE_FAMILY`,`ALLOWANCE_HOUSING`,`ALLOWANCE_UNEMPLOYMENT`,`ALLOWANCE_DISABILITY`,`ALLOWANCE_HEALTH`,`ALLOWANCE_INCOME_SUPPORT`,`STATE_SUBSIDY`,`GAMBLING_GAIN`,`RENTAL_INCOME`,`RECEIVED_ALIMONY`,`FREELANCE`,`WAGE`,`WAGE_BONUS`,`WAGE_SALARY_ADVANCE`,`WAGE_ADVANCE_PAYMENT`,`RETIREMENT_PENSION`,`REVERSIONARY_PENSION`,`DISSAVING`,`OTHER_ENTRY`
type	string	Nature of the transaction Enum: `CASH_DEPOSIT`,`CASH_WITHDRAWAL`,`CHECK_DEPOSIT`,`CHECK`,`INCOMING_TRANSFER`,`INCOMING_INTERNAL_TRANSFER`,`OUTGOING_TRANSFER`,`OUTGOING_INTERNAL_TRANSFER`,`CARD`,`CARD_REFUND`,`DIRECT_DEBIT`,`INCOMING_CARD`,`CREDIT`,`DEBIT`
isRejected	boolean	Indicates if the transaction has been rejected or not. Deprecated
counterPartId	string	Id of the counterpart if the transaction is or has been rejected. Deprecated
relatedTransactions11 fields	object	List of identifiers related to this transaction.
retryOf	string	Id corresponding to the transaction retried by this transaction Flexible link
retriedOn	string	Id of the transaction corresponding to the retry of this transaction Flexible link
rejectionOf	string	Id of the rejected transaction corresponding to this transaction Robust link
rejectedOn	string	Id of the transaction corresponding to the rejection of this one Robust link
transferOf	string	Id of the transferred transaction Robust link
transferedOn	string	Id of the transaction corresponding to the transfer of this one Robust link Deprecated
transferredOn	string	Id of the transaction corresponding to the transfer of this one Robust link
resetOf	string	Id of the reset transaction Robust link
resetOn	string	Id of the transaction this transaction is reset on Robust link
refundOf	string	Id of the transaction that is going to be refunded Robust link
refundedOn	string	Id of the refunded of the transaction Robust link
groupId	string	Group id of the transaction Deprecated
descriptionGroupId	string	Description of the transaction group id Deprecated
isInternationalTransfer	boolean	Indicates if the transaction is international or not
isComing	boolean	Indicates if the transaction will be debited in the future or not.
aggregator3 fields	object	Information set by the aggregator
id	string	Id of the transaction/account on the aggregator
type	string
category	string
comment	string	Comment on the transaction
isNonAnalysed	boolean	Indicates if the transaction is non analysed in the case of the full months analysis configuration
createdAt	date-time	Creation date of the transaction in Algoan's database
updatedAt	date-time	Last update date of the transaction in Algoan's database
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Subscription

Subscription to Algoan's platform events.

/v1/subscriptions/{subscriptionId}

GET

/v1/subscriptions/{subscriptionId}

PATCH

/v1/subscriptions/{subscriptionId}

Get the list of subscriptions

Auth

Query String

filter

string

mongo query to filter the subscriptions

GET /v1/subscriptions

Responses

200

array	array[object]
id	string	Id of the subscription
secret	string	Secret key
encryptionFlag	boolean	Encrypted secret flag
target	string	target
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag
oAuth2Credentials9 fields	object	OAuth2 Credentials
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	mtls Credentials
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
createdAt	date-time	Creation date of the subscription
updatedAt	date-time	Last update date of the subscription

401

Authentication required

403

Insufficient permissions

Response

POST /subscriptions/

Auth

Headers

x-vpc-client string

Request Body

object	object
id	string	The subscription ID
subscriberId	string	The subscriber ID Deprecated
projectId		The project ID
string	string
target	string	Target URL for the webhook
eventName	string	The event name to subscribe to Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
secret	string	The secret used to sign the webhook payloads
oAuth2Credentials9 fields	object	OAuth2 credentials for the webhook
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	mTLS credentials for the webhook
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	Webhook retry delays in seconds If not provided, default values will be used
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag

POST /v1/subscriptions

Responses

201

Created

object	object
id	string	Id of the subscription
secret	string	Secret key
encryptionFlag	boolean	Encrypted secret flag
target	string	target
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag
oAuth2Credentials9 fields	object	OAuth2 Credentials
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	mtls Credentials
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
createdAt	date-time	Creation date of the subscription
updatedAt	date-time	Last update date of the subscription

400

Validation failed

401

Authentication required

403

Insufficient permissions

Response

DELETE /subscriptions/:subscriptionId

Auth

Path Params

subscriptionId string

DELETE /v1/subscriptions/{subscriptionId}

Responses

204

No Content

object	object
id	string	Id of the subscription
secret	string	Secret key
encryptionFlag	boolean	Encrypted secret flag
target	string	target
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag
oAuth2Credentials9 fields	object	OAuth2 Credentials
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	mtls Credentials
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
createdAt	date-time	Creation date of the subscription
updatedAt	date-time	Last update date of the subscription

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

GET /subscriptions/:subscriptionId

Auth

Path Params

subscriptionId string

GET /v1/subscriptions/{subscriptionId}

Responses

200

object	object
id	string	Id of the subscription
secret	string	Secret key
encryptionFlag	boolean	Encrypted secret flag
target	string	target
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag
oAuth2Credentials9 fields	object	OAuth2 Credentials
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	mtls Credentials
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
createdAt	date-time	Creation date of the subscription
updatedAt	date-time	Last update date of the subscription

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

PATCH /subscriptions/:subscriptionId

Auth

Path Params

subscriptionId string

Request Body

object	object
target	string	The target URL of the subscription
status	string	The status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
oAuth2Credentials9 fields	object	The OAuth2 credentials for the subscription
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	The mTLS credentials for the subscription
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	The webhook retry delays for the subscription
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag

PATCH /v1/subscriptions/{subscriptionId}

Responses

200

object	object
id	string	Id of the subscription
secret	string	Secret key
encryptionFlag	boolean	Encrypted secret flag
target	string	target
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Force sending the `webhook_failed` notification email even when emails are globally disabled through the `disableEmails` configuration flag
oAuth2Credentials9 fields	object	OAuth2 Credentials
authUrl	string	The authorization URL for obtaining OAuth2 tokens
refreshUrl	string	The refresh URL for obtaining new tokens
clientId	string	The client ID for OAuth2 authentication
clientSecret	string	The client secret for OAuth2 authentication
username	string	The username for OAuth2 authentication
password	string	The password for OAuth2 authentication
scope	string	The scope for OAuth2 authentication
clientAssertionOptions	object	Client assertion options for OAuth2 authentication
type	string	The type of the client assertion
aud	array[string]	The audience for the client assertion
additionalHeaders	object	Additional headers to include in OAuth2 requests
*	string
mtlsCredentials3 fields	object	mtls Credentials
cert	string	Client certificate in PEM format.
key	string	Client private key in PEM format.
ca	string	CA certificate in PEM format. Needed if connecting to a server using a self-signed certificate or a certificate signed by a private CA.
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
createdAt	date-time	Creation date of the subscription
updatedAt	date-time	Last update date of the subscription

400

Validation failed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

Event

Event related to webhooks' subscriptions

GET

/v1/subscriptions/{subscriptionId}/events

PATCH

/v1/subscriptions/{subscriptionId}/events/{eventId}

GET /subscriptions/:subscriptionId/events

Auth

Path Params

subscriptionId string

Query String

queryDto6 fields	object
applicationId	string	The application ID
lowIndex	number	The low index for pagination
highIndex	number	The high index for pagination
page	number	The page number for pagination
limit	number	The limit of items per page for pagination
filter	string	The filter string to filter events

GET /v1/subscriptions/{subscriptionId}/events

Responses

200

object	object
resources12 fields	array[object]
id	string	Id of the event
statuses4 fields	array[object]	Status of the event
_id	string	Id of the event
name	string	Status name of the event Enum: `IN_PROGRESS`,`ACK`,`PROCESSED`,`FAILED`,`ERROR`,`WARNING`,`CRITICAL`
error	object	Error object in case of status `ERROR`
code	string	Error code
message	string	Error message
createdAt	date-time	Time (timestamp) when the new status has been set
latestStatus	string	Latest status of the event Enum: `IN_PROGRESS`,`ACK`,`PROCESSED`,`FAILED`,`ERROR`,`WARNING`,`CRITICAL`
time	number	Timestamp from pub/sub
subscription13 fields	object	Subscription
_id	string	The Subscription unique identifier auto-generated by MongoDB
id	string	Id of the subscription
organizationId		Id of the organization who possess the subscription
string	string
projectId		Id of the project that possess the subscription
string	string
disableRecovery	boolean	Disable recovery flag
target	string	URL target of the subscription
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	Status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Internal flag, forwarded from the subscription, that forces the `webhook_failed` notification email even when emails are disabled through the `disableEmails` config flag
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
index	number	Index
payload	object	Payload
_references	object	Internal references
_data	object	Internal data
_emitter	object	Service who emitted the event
_id	string	ID of the event
updatedAt	date-time	Date of update
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

PATCH /subscriptions/:subscriptionId/events/:eventId

Auth

Path Params

subscriptionId	string
eventId	string

Request Body

object	object
status	string	New status of the event Enum: `IN_PROGRESS`,`ACK`,`PROCESSED`,`FAILED`,`ERROR`,`WARNING`,`CRITICAL`
error	object	Error information if the event failed
code	string	Error code
message	string	Error message

PATCH /v1/subscriptions/{subscriptionId}/events/{eventId}

Responses

200

object	object
id	string	Id of the event
statuses4 fields	array[object]	Status of the event
_id	string	Id of the event
name	string	Status name of the event Enum: `IN_PROGRESS`,`ACK`,`PROCESSED`,`FAILED`,`ERROR`,`WARNING`,`CRITICAL`
error	object	Error object in case of status `ERROR`
code	string	Error code
message	string	Error message
createdAt	date-time	Time (timestamp) when the new status has been set
latestStatus	string	Latest status of the event Enum: `IN_PROGRESS`,`ACK`,`PROCESSED`,`FAILED`,`ERROR`,`WARNING`,`CRITICAL`
time	number	Timestamp from pub/sub
subscription13 fields	object	Subscription
_id	string	The Subscription unique identifier auto-generated by MongoDB
id	string	Id of the subscription
organizationId		Id of the organization who possess the subscription
string	string
projectId		Id of the project that possess the subscription
string	string
disableRecovery	boolean	Disable recovery flag
target	string	URL target of the subscription
subscriberId	string	Id of the subscriber Deprecated
eventName	string	Name of the event subscribed Enum: `products_required`,`pricings_required`,`insurances_required`,`decision_required`,`bankreader_link_required`,`bankreader_configuration_required`,`bankreader_required`,`bankreader_completed`,`expert_indicators_completed`,`financial_check_completed`,`credit_score_required`,`credit_score_completed`,`conversation_link_created`,`application_updated`,`aggregator_link_required`,`bank_details_required`,`analysis_completed`,`bank_details_fetched`,`analysis_failed`,`report_completed`,`report_failed`,`folder_action_required`,`require_folder_action`,`kyc_documents_list_required`,`legal_documents_required`,`kyc_file_uploaded`,`kyc_folder_validation_required`,`kyc_folder_created`,`electronic_signature_link_required`,`electronic_signature_configuration_required`,`electronic_signature_completed`,`kyc_manager_link_required`,`kyc_manager_configuration_required`,`kyc_manager_process_completed`,`kyc_banking_information_completed`,`kyc_banking_information_link_required`,`kyc_face_matching_completed`,`kyc_face_matching_link_required`,`kyc_proof_of_address_completed`,`kyc_proof_of_address_link_required`,`kyc_proof_of_identity_completed`,`kyc_proof_of_identity_link_required`,`kyc_proof_of_income_completed`,`kyc_proof_of_income_link_required`,`kyc_proof_of_identity_face_match_completed`,`kyc_proof_of_identity_face_match_link_required`,`kyc_banking_information_configuration_required`,`kyc_face_matching_configuration_required`,`kyc_proof_of_address_configuration_required`,`kyc_proof_of_identity_configuration_required`,`kyc_proof_of_income_configuration_required`,`kyc_proof_of_identity_face_match_configuration_required`,`kyc_insurance_contract_link_required`,`kyc_insurance_contract_completed`,`kyc_product_contract_link_required`,`kyc_product_contract_completed`,`kyc_information_link_required`,`kyc_information_completed`,`kyc_debit_mandate_link_required`,`kyc_debit_mandate_completed`,`kyc_records_link_required`,`kyc_records_completed`,`kyc_legal_mentions_link_required`,`kyc_legal_mentions_completed`,`kyc_receipt_link_required`,`kyc_receipt_completed`,`kyc_others_link_required`,`kyc_others_completed`,`kyc_others_configuration_required`,`external_error`,`send_email`,`send_raw_email`,`send_raw_slack`,`send_sms`,`send_raw_sms`,`resource_expired`,`recovery_required`,`offers_required`,`contract_required`,`offer_decision_required`,`creditworthiness_required`,`analysis_deletion_required`,`session_connect_state_changed`,`service_account_created`,`service_account_updated`,`service_account_deleted`
status	string	Status of the subscription Enum: `ACTIVE`,`INACTIVE`,`DEACTIVATE`
clientVpc	string	Client VPC
useProxy	boolean	Use Proxy
forceSendEmail	boolean	Internal flag, forwarded from the subscription, that forces the `webhook_failed` notification email even when emails are disabled through the `disableEmails` config flag
webhookRetryDelays	array[number]	Webhook retry delays in milliseconds Array of delays for retry attempts when webhook fails Delays are counted from the previous attempt
index	number	Index
payload	object	Payload
_references	object	Internal references
_data	object	Internal data
_emitter	object	Service who emitted the event
_id	string	ID of the event
updatedAt	date-time	Date of update

400

Validation failed

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

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.

/v2/sessions/{id}/session-data

Register a customer

Auth

Headers

Authorization string

Query String

registerQueryDto	object
includeRestrictedToken	boolean	Create a user with restricted access scope in its token

Request Body

object	object
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
userSegment	string	Used to differentiate the use-case and origin of the customer
personalDetails3 fields	object	Personal information about the consumer
identity9 fields	object	Identity information about a customer
nationality	string	Nationality
firstName	string	First name
lastName	string	Last name
birthName	string	Birth name
birthDate	string	Birth date
birthCity	string	Birth city
birthZipCode	string	Birth Zip code
birthCountry	string	Birth country
documentNumber	string	ID number from official documents such as passport, national id number, etc.
contact7 fields	object	Contact information about a customer
email	string	Electronic mail address
phoneNumber	string	Phone number (E.164 format)
street	string	Street
additionalInformation	string	Additional information about the address
city	string	City where the customer lives
zipCode	string	Zip code of the customer's city
country	string	Country of the customer
household3 fields	object	Household information about a customer
maritalStatus	string	State of this report Enum: `COHABITING`,`DIVORCED`,`MARRIED`,`SEPARATED`,`SINGLE`,`WIDOWED`,`CIVIL_PARTNERSHIP`
numberOfDependentChildren	number	The number of children the customer is in charge of
numberOfOtherDependents	number	The number of other people the customer is in charge of
personalDetailsOfCoBorrower3 fields	object	Personal information of the co-borrower
identity9 fields	object	Identity information about a customer
nationality	string	Nationality
firstName	string	First name
lastName	string	Last name
birthName	string	Birth name
birthDate	string	Birth date
birthCity	string	Birth city
birthZipCode	string	Birth Zip code
birthCountry	string	Birth country
documentNumber	string	ID number from official documents such as passport, national id number, etc.
contact7 fields	object	Contact information about a customer
email	string	Electronic mail address
phoneNumber	string	Phone number (E.164 format)
street	string	Street
additionalInformation	string	Additional information about the address
city	string	City where the customer lives
zipCode	string	Zip code of the customer's city
country	string	Country of the customer
household3 fields	object	Household information about a customer
maritalStatus	string	State of this report Enum: `COHABITING`,`DIVORCED`,`MARRIED`,`SEPARATED`,`SINGLE`,`WIDOWED`,`CIVIL_PARTNERSHIP`
numberOfDependentChildren	number	The number of children the customer is in charge of
numberOfOtherDependents	number	The number of other people the customer is in charge of

POST /v2/register

Responses

201

Created

object	object
accessToken	string
restrictedToken	string
customer16 fields	object
id	string	Id of the customer
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
connect	object	Properties of the customer for the Connect product Deprecated
serviceAccountClientId	string	Client Id of the corresponding service account
dashboard13 fields	object	Dashboard Property of the customer for the new dashboard. Only present if the project contains the dashboard product.
currentState	string	Current state of the customer's report Enum: `NEW`,`VIEWED`,`ARCHIVED`
historyState3 fields	array[object]	States history: represents an array containing the history of the customer's report
createdAt	string	The date the state was created at
state	string	State of this report Enum: `NEW`,`VIEWED`,`ARCHIVED`
userId	string	User that consulted the dashboard and changed the report state
invitationHistory4 fields	array[object]	Invitation history: represents an array containing the history of the customer's invitations
date	string	The date of the event
type	string	type of the event Enum: `invitation_link_sent`,`invitation_link_retrieved`,`invitation_link_created`
channel	string	Channel of the invitation email or sms Enum: `email`,`sms`
senderUsername	string	The username of the sender
numberOfViews	number	Number of times the report was viewed
numberOfAnalyses	number	Number of COMPLETED analyses linked to the customer Deprecated
newWithAnalysis	boolean	New with analysis
onboarding	object	New with analysis
team	string	Team corresponding to the customer's dashboard
customizedMonthlyAmount	number	Monthly amount set by customer
analysesConfig	object	Analyses config of the customer: 1st string key of the map is an analysis Id 2st string key of the map is a cash flow Id
*	object
*	object
isIncludedInRemainderToLive	boolean	Indicate if the cashflow is included in the calculation of remainder to live
comments4 fields	array[object]	Customer comments
value	string	Value of the comment
authorEmail	string	Electronic mail address of comment author
createdAt	date-time	Creation date of the comment
updatedAt	date-time	Last update date of the comment
createdAt	string	Creation date
updatedAt	string	Last update date
openBankingInformation	object	Information about the customer retrieved from open banking
owners	array[object]	Account owners information
name	string	Name of the owner of the account
reports4 fields	object	Reported information about customer's analyses
completedAnalyses3 fields	object	Reported information about customer's completed analyses
count	number	Number of analyses completed linked to the customer
date	string	Date of the last analysis completed for the customer
url	string	URL of the last analysis completed for the customer
lastFailedAnalysis3 fields	object	Reported information about customer's last analysis in error
date	string	Date of the last analysis failed for the customer
url	string	URL of the last analysis failed for the customer
type	string	Type of the last analysis failed for the customer
userJourneyState	string	Reported information about customer's last state in the user journey Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
pdfProcessingState	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
owner3 fields	object	The organization and project where the customer belongs to originally
organizationId	string	The organization's id
projectId	string	The project's id
projectName	string	The project's name
shares3 fields	array[object]	The projects that the customer is shared with
organizationId	string	The organization's id
projectId	string	The project's id
sharedAt	string	The time of share
storage4 fields	object	Storage Properties of the customer
type	string	Type of storage when customer data is expired Enum: `DELETION`,`PARTIAL_DELETION`,`DEMO`
expiresAt	date-time	Expiration date of customer data
partiallyExpiresAt	date-time	Partial expiration date of customer data
isAnonymized	boolean	Indicates if the customer has been anonymized after expiration
createdAt	string	Creation date of the customer
updatedAt	string	Last date of update of the customer
usage	string	Usage type of the customer: Business or Consumer Enum: `CONSUMER`,`BUSINESS`
userSegment	string	Used to differentiate the use-case and origin of the customer
personalDetails3 fields	object
identity9 fields	object	Identity information about a customer
nationality	string	Nationality
firstName	string	First name
lastName	string	Last name
birthName	string	Birth name
birthDate	string	Birth date
birthCity	string	Birth city
birthZipCode	string	Birth Zip code
birthCountry	string	Birth country
documentNumber	string	ID number from official documents such as passport, national id number, etc.
contact7 fields	object	Contact information about a customer
email	string	Electronic mail address
phoneNumber	string	Phone number (E.164 format)
street	string	Street
additionalInformation	string	Additional information about the address
city	string	City where the customer lives
zipCode	string	Zip code of the customer's city
country	string	Country of the customer
household3 fields	object	Household information about a customer
maritalStatus	string	State of this report Enum: `COHABITING`,`DIVORCED`,`MARRIED`,`SEPARATED`,`SINGLE`,`WIDOWED`,`CIVIL_PARTNERSHIP`
numberOfDependentChildren	number	The number of children the customer is in charge of
numberOfOtherDependents	number	The number of other people the customer is in charge of
personalDetailsOfCoBorrower3 fields	object
identity9 fields	object	Identity information about a customer
nationality	string	Nationality
firstName	string	First name
lastName	string	Last name
birthName	string	Birth name
birthDate	string	Birth date
birthCity	string	Birth city
birthZipCode	string	Birth Zip code
birthCountry	string	Birth country
documentNumber	string	ID number from official documents such as passport, national id number, etc.
contact7 fields	object	Contact information about a customer
email	string	Electronic mail address
phoneNumber	string	Phone number (E.164 format)
street	string	Street
additionalInformation	string	Additional information about the address
city	string	City where the customer lives
zipCode	string	Zip code of the customer's city
country	string	Country of the customer
household3 fields	object	Household information about a customer
maritalStatus	string	State of this report Enum: `COHABITING`,`DIVORCED`,`MARRIED`,`SEPARATED`,`SINGLE`,`WIDOWED`,`CIVIL_PARTNERSHIP`
numberOfDependentChildren	number	The number of children the customer is in charge of
numberOfOtherDependents	number	The number of other people the customer is in charge of
business15 fields	object
id	string	Id of the customer
customIdentifier	string	A custom identifier that will be attached to the customer. This can be used to identify a customer based on the client's internal reference.
aggregationDetails9 fields	object	Information about the AIS provider used for the report
userId	string	Aggregator's customer identifier This value is set to null if the access is revoked
aggregatorName	string	Name of the aggregator company Enum: `BUDGET_INSIGHT`,`BRIDGE`,`TINK`,`LINXO_CONNECT`,`MASTERCARD_OPEN_FINANCE_DATA`,`OTHER`
callbackUrl	string	Callback URL set for a customer. Used to redirect the customer back to your user journey if you are using the aggregation in REDIRECT mode.
token	string	Temporary access token set for Algoan's UI to communicate with the aggregator's API
mode	string	Mode used for the customer journey Enum: `REDIRECT`,`API`,`IFRAME`
redirectUrl	string	Redirect URL used for the end-user. Specific to REDIRECT mode
apiUrl	string	URL used to call API using API mode
iframeUrl	string	Iframe URL used for the end-user. Specific to IFRAME mode
clientId	string	Aggregator client ID used to authenticate a customer with the organization
connect	object	Properties of the customer for the Connect product Deprecated
serviceAccountClientId	string	Client Id of the corresponding service account
dashboard13 fields	object	Dashboard Property of the customer for the new dashboard. Only present if the project contains the dashboard product.
currentState	string	Current state of the customer's report Enum: `NEW`,`VIEWED`,`ARCHIVED`
historyState3 fields	array[object]	States history: represents an array containing the history of the customer's report
createdAt	string	The date the state was created at
state	string	State of this report Enum: `NEW`,`VIEWED`,`ARCHIVED`
userId	string	User that consulted the dashboard and changed the report state
invitationHistory4 fields	array[object]	Invitation history: represents an array containing the history of the customer's invitations
date	string	The date of the event
type	string	type of the event Enum: `invitation_link_sent`,`invitation_link_retrieved`,`invitation_link_created`
channel	string	Channel of the invitation email or sms Enum: `email`,`sms`
senderUsername	string	The username of the sender
numberOfViews	number	Number of times the report was viewed
numberOfAnalyses	number	Number of COMPLETED analyses linked to the customer Deprecated
newWithAnalysis	boolean	New with analysis
onboarding	object	New with analysis
team	string	Team corresponding to the customer's dashboard
customizedMonthlyAmount	number	Monthly amount set by customer
analysesConfig	object	Analyses config of the customer: 1st string key of the map is an analysis Id 2st string key of the map is a cash flow Id
*	object
*	object
isIncludedInRemainderToLive	boolean	Indicate if the cashflow is included in the calculation of remainder to live
comments4 fields	array[object]	Customer comments
value	string	Value of the comment
authorEmail	string	Electronic mail address of comment author
createdAt	date-time	Creation date of the comment
updatedAt	date-time	Last update date of the comment
createdAt	string	Creation date
updatedAt	string	Last update date
openBankingInformation	object	Information about the customer retrieved from open banking
owners	array[object]	Account owners information
name	string	Name of the owner of the account
reports4 fields	object	Reported information about customer's analyses
completedAnalyses3 fields	object	Reported information about customer's completed analyses
count	number	Number of analyses completed linked to the customer
date	string	Date of the last analysis completed for the customer
url	string	URL of the last analysis completed for the customer
lastFailedAnalysis3 fields	object	Reported information about customer's last analysis in error
date	string	Date of the last analysis failed for the customer
url	string	URL of the last analysis failed for the customer
type	string	Type of the last analysis failed for the customer
userJourneyState	string	Reported information about customer's last state in the user journey Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
pdfProcessingState	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
owner3 fields	object	The organization and project where the customer belongs to originally
organizationId	string	The organization's id
projectId	string	The project's id
projectName	string	The project's name
shares3 fields	array[object]	The projects that the customer is shared with
organizationId	string	The organization's id
projectId	string	The project's id
sharedAt	string	The time of share
storage4 fields	object	Storage Properties of the customer
type	string	Type of storage when customer data is expired Enum: `DELETION`,`PARTIAL_DELETION`,`DEMO`
expiresAt	date-time	Expiration date of customer data
partiallyExpiresAt	date-time	Partial expiration date of customer data
isAnonymized	boolean	Indicates if the customer has been anonymized after expiration
createdAt	string	Creation date of the customer
updatedAt	string	Last date of update of the customer
usage	string	Usage type of the customer: Business or Consumer Enum: `CONSUMER`,`BUSINESS`
userSegment	string	Used to differentiate the use-case and origin of the customer
businessDetails	object	Personal information about the business customer

400

Validation failed

401

Authentication required

403

Insufficient permissions

Response

Find a list of sessions

Auth

GET /v2/sessions

Responses

200

object	object
resources21 fields	array[object]
_id	string	Algoan unique identifier
organizationId	string	The organization's id
projectId	string	The project's id
userId	string	The Id of the Keycloak user linked to the session.
customerId	string	The customer's id
businessId	string	The business's id (for business usage)
folderId	string	The folder's id
status	string	The session's status Enum: `IN_PROGRESS`,`EXPIRED`,`COMPLETED`
updatedAt	string	The date of modification, populated by Mongoose
accessedAt	string	The date of the last access (read or write)
customerProps	object	The properties persisted by a frontend app
connectorProps	object	The properties persisted by a connector
connectProps28 fields	object	The properties persisted for Connect
redirectUrl	string	The URL to redirect to the user, at the end of Connect process
chosenBankId	string	The Id of the bank chosen by customer
chosenBankBranchId	string	The value of chosen bank branch
customerConsentVersion	string	The version of Terms & Conditions agreed by the customer Deprecated
customerConsentDate	string	The date of Terms & Conditions agreed by the customer Deprecated
termsConsent	object	Terms and conditions consent information agreed by the customer
version	string	Version of the consent
date	string	Date when the consent was given
privacyPolicyConsent	object	Privacy policy consent information agreed by the customer
version	string	Version of the consent
date	string	Date when the consent was given
aggregatorUrl	string	The redirect Url of the aggregator
aggregatorConnections6 fields	array[object]	The aggregator connections
bank4 fields	object
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
aggregator3 fields	object
id	string	Id of the transaction/account on the aggregator
type	string
category	string
connection9 fields	object
id	string
userId	string
state	string	Enum: ``,`SCARequired`,`webauthRequired`,`additionalInformationNeeded`,`decoupled`,`validating`,`actionNeeded`,`passwordExpired`,`wrongpass`,`rateLimiting`,`websiteUnavailable`,`bug`,`notSupported`
stateError	object
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
authorizationId	string
accessToken	string
loginToken	string
isAggregated	boolean
resolvedAt	date-time
accountSelection3 fields	object
state	string	Enum: `NO_ACCOUNT_FOR_SELECTION`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`LOCAL_CURRENCY_ACCOUNTS_AUTO_SELECTED`,`COMPLETED`
accountIds	array[string]
stateError	object
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
aggregatorDataRetrievalStatus	string	Enum: `PENDING`,`COMPLETED`,`ERROR` Deprecated
aggregatorDataRetrieval2 fields	object
accounts	object
*	boolean
status	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
hasAccounts	boolean	Indicates if at least one account has been fetched
hasAggregatedCheckingAccount	boolean	Indicates if at least one checking account has been aggregated
isAnalysisRequired	boolean	Indicates if the analysis needs to be created
isAnalysisCreated	boolean	Indicates if the analysis is already launched via either webhook or pubsub event
analysisId	string	The Id of the created analysis
numberOfRequiredAggregations	number	The number of aggregations made by the customer
numberOfReceivedAggregations	number	The number of aggregations whose data are received from the aggregator via webhook
state	string	State of a Connect session. It represents the progress of the user's journey. Enum: `IN_PROGRESS`,`SUCCESS`,`ERROR`,`EXIT`,`EXPIRED`,`BANK_NOT_FOUND`
stateError	object	State error
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
userJourneyState	string	State of a user journey. It represents the most advanced progress of the user's journey. Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
isBankConnectionInProgress	boolean	True if the user is connecting to his bank. Otherwise, false.
pingedAt	string	Date of the last ping request sent by the user
decoupledState	string	State of a decoupled bank connection. The decoupled bank connection means that the user do the bank authentication on another device than the one he started the process. Enum: `IN_PROGRESS`,`SUCCESS`,`CANCEL`
invitationSenderEmail	string	Email of the user that sends an invitation for TD to a customer
isIosUser	boolean	True if Ios user
injectedUrlParams	object	Optional URL query parameters passed from the client
*	string
featureFlags	object	Feature flags for the session
*	string
advancedChecks4 fields	object	Checks related to transaction data advanced
isActivityScoreBelowThreshold	boolean	True if activity score is below the threshold
hasInternalTransfers	boolean	True if internal transfers without a matching account have been detected
noRevenueDetected	boolean	True if no revenue has been detected
isMonthlyIncomeBelowThreshold	boolean	True if monthly income is below the configured threshold
uiInteractions	object	UI interactions tracking (e.g., button clicks, checkbox states)
otp3 fields	object
code	string	The code to be sent back and forth to the customer to authenticate its identity
nbOfAttempts	number	Number of attempts to validate already done
createdAt	date-time	Created by mongoose
phoneNumber	string
accessToken	string	Access Token that will be returned in the route GET /token
uuid	string	UUID to retrieve the access token in the route GET /token
isUserDeleted	boolean	true if the user associated to the session id has been deleted
code	string	A code from which a JWT can be exchanged (especially, for permanent user flow of Bank Data). It can be used only once.
expiresAt	date-time	A code from which a JWT can be exchanged (especially, for permanent user flow of Bank Data). It can be used only once. /
jtis	array[string]	JWT ids. Property used to ensure that only some specific JWTs can patch a session.
pagination6 fields	object
next	string
previous	string
first	string
last	string
totalPages	number
totalResources	number

400

Bad Request if the pagination parameters are invalid

401

Authentication required

403

Insufficient permissions

Response

Create a new session

Auth

Request Body

The data for session creation

object	object
customerId	string	The customer's id
businessId	string	The business's id, if the project usage is a business (stored as customerId in the database)
folderId	string	The folder's id
dashboard	object	Dashboard Property of the customer for the new dashboard
onboarding	object	Onboarding data of a customer
phoneNumber	string	Phone Number of the customer in order to use for OTP process
uuid	string	UUID used to retrieve accessToken
userId	string	The Id of the Keycloak user linked to the session. Cannot be set if the user who creates the session is anonymous.

POST /v2/sessions

Responses

201

Created

object	object
_id	string	Algoan unique identifier
organizationId	string	The organization's id
projectId	string	The project's id
userId	string	The Id of the Keycloak user linked to the session.
customerId	string	The customer's id
businessId	string	The business's id (for business usage)
folderId	string	The folder's id
status	string	The session's status Enum: `IN_PROGRESS`,`EXPIRED`,`COMPLETED`
updatedAt	string	The date of modification, populated by Mongoose
accessedAt	string	The date of the last access (read or write)
customerProps	object	The properties persisted by a frontend app
connectorProps	object	The properties persisted by a connector
connectProps28 fields	object	The properties persisted for Connect
redirectUrl	string	The URL to redirect to the user, at the end of Connect process
chosenBankId	string	The Id of the bank chosen by customer
chosenBankBranchId	string	The value of chosen bank branch
customerConsentVersion	string	The version of Terms & Conditions agreed by the customer Deprecated
customerConsentDate	string	The date of Terms & Conditions agreed by the customer Deprecated
termsConsent	object	Terms and conditions consent information agreed by the customer
version	string	Version of the consent
date	string	Date when the consent was given
privacyPolicyConsent	object	Privacy policy consent information agreed by the customer
version	string	Version of the consent
date	string	Date when the consent was given
aggregatorUrl	string	The redirect Url of the aggregator
aggregatorConnections6 fields	array[object]	The aggregator connections
bank4 fields	object
id	string	Id of the account - aggregator unique identifier
logoUrl	string	URL of the logo of the account's bank
name	string	Name of the account's bank
country	string	Code of the country of the account's bank
aggregator3 fields	object
id	string	Id of the transaction/account on the aggregator
type	string
category	string
connection9 fields	object
id	string
userId	string
state	string	Enum: ``,`SCARequired`,`webauthRequired`,`additionalInformationNeeded`,`decoupled`,`validating`,`actionNeeded`,`passwordExpired`,`wrongpass`,`rateLimiting`,`websiteUnavailable`,`bug`,`notSupported`
stateError	object
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
authorizationId	string
accessToken	string
loginToken	string
isAggregated	boolean
resolvedAt	date-time
accountSelection3 fields	object
state	string	Enum: `NO_ACCOUNT_FOR_SELECTION`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`LOCAL_CURRENCY_ACCOUNTS_AUTO_SELECTED`,`COMPLETED`
accountIds	array[string]
stateError	object
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
aggregatorDataRetrievalStatus	string	Enum: `PENDING`,`COMPLETED`,`ERROR` Deprecated
aggregatorDataRetrieval2 fields	object
accounts	object
*	boolean
status	string	Enum: `PENDING`,`COMPLETED`,`ERROR`
hasAccounts	boolean	Indicates if at least one account has been fetched
hasAggregatedCheckingAccount	boolean	Indicates if at least one checking account has been aggregated
isAnalysisRequired	boolean	Indicates if the analysis needs to be created
isAnalysisCreated	boolean	Indicates if the analysis is already launched via either webhook or pubsub event
analysisId	string	The Id of the created analysis
numberOfRequiredAggregations	number	The number of aggregations made by the customer
numberOfReceivedAggregations	number	The number of aggregations whose data are received from the aggregator via webhook
state	string	State of a Connect session. It represents the progress of the user's journey. Enum: `IN_PROGRESS`,`SUCCESS`,`ERROR`,`EXIT`,`EXPIRED`,`BANK_NOT_FOUND`
stateError	object	State error
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
userJourneyState	string	State of a user journey. It represents the most advanced progress of the user's journey. Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
isBankConnectionInProgress	boolean	True if the user is connecting to his bank. Otherwise, false.
pingedAt	string	Date of the last ping request sent by the user
decoupledState	string	State of a decoupled bank connection. The decoupled bank connection means that the user do the bank authentication on another device than the one he started the process. Enum: `IN_PROGRESS`,`SUCCESS`,`CANCEL`
invitationSenderEmail	string	Email of the user that sends an invitation for TD to a customer
isIosUser	boolean	True if Ios user
injectedUrlParams	object	Optional URL query parameters passed from the client
*	string
featureFlags	object	Feature flags for the session
*	string
advancedChecks4 fields	object	Checks related to transaction data advanced
isActivityScoreBelowThreshold	boolean	True if activity score is below the threshold
hasInternalTransfers	boolean	True if internal transfers without a matching account have been detected
noRevenueDetected	boolean	True if no revenue has been detected
isMonthlyIncomeBelowThreshold	boolean	True if monthly income is below the configured threshold
uiInteractions	object	UI interactions tracking (e.g., button clicks, checkbox states)
otp3 fields	object
code	string	The code to be sent back and forth to the customer to authenticate its identity
nbOfAttempts	number	Number of attempts to validate already done
createdAt	date-time	Created by mongoose
phoneNumber	string
accessToken	string	Access Token that will be returned in the route GET /token
uuid	string	UUID to retrieve the access token in the route GET /token
isUserDeleted	boolean	true if the user associated to the session id has been deleted
code	string	A code from which a JWT can be exchanged (especially, for permanent user flow of Bank Data). It can be used only once.
expiresAt	date-time	A code from which a JWT can be exchanged (especially, for permanent user flow of Bank Data). It can be used only once. /
jtis	array[string]	JWT ids. Property used to ensure that only some specific JWTs can patch a session.

400

Validation failed

401

Authentication required

403

Insufficient permissions

Response

Get session data

Auth

Path Params

string

The session's id

GET /v2/sessions/{id}/session-data

Responses

200

object	object
state	string	Enum: `IN_PROGRESS`,`SUCCESS`,`ERROR`,`EXIT`,`EXPIRED`,`BANK_NOT_FOUND`
stateErrors	array[object]
code
string	string	Enum: `UNKNOWN_ENTITY`,`UNAUTHORIZED`,`FORBIDDEN`,`ALREADY_EXISTS`,`BAD_REQUEST`,`INTERNAL_ERROR`,`SESSION_COMPLETED`,`SESSION_EXPIRED`,`USAGE_NOT_SUPPORTED`,`NO_CHECKING_ACCOUNT_SELECTED`,`NO_LOCAL_CURRENCY_ACCOUNT_SELECTED`,`CONNECTION_FAILURE`
message	string
userJourneyState	string	Enum: `CUSTOMER_CREATED`,`CREATED`,`INVITATION_SENT`,`STARTED`,`CONSENT_GIVEN`,`BANK_SELECTED`,`QR_CODE_SCANNED`,`AGGREGATION_STARTED`,`AGGREGATION_FINISHED_ERROR`,`AGGREGATION_FINISHED_SUCCESS`,`FINISHED_ERROR`,`FINISHED_SUCCESS`,`ANALYSIS_PENDING`,`ANALYSIS_ERROR`,`ANALYSIS_RETRIED`,`ANALYSIS_SUCCESS`
termsConsent	object
version	string	Version of the consent
date	string	Date when the consent was given
privacyPolicyConsent	object
version	string	Version of the consent
date	string	Date when the consent was given

401

Authentication required

403

Insufficient permissions

404

Not Found

Response

API reference Algoan Pro 2.0.0Private License

Authentication

Authentication

Create a new access token

Business

Find a list of businesses

Create a new business

Find a business by its id

Update a single business based on a single ID

Analysis

Find all analysis by organization/project

Create analysis add the accounts and trigger analysis calculation if not empty

Find an analysis by id

Update analysis: add the accounts and trigger analysis computation

Find daily balances linked to an analysis

Trigger analysis computation

Score

Find an analysis by id and return only scores

Account

Find all accounts linked to an analysis

Find all Daily Balances linked to an account from an analysis

Transaction

Find all transactions linked to an account from an analysis

Find all transactions of an analysis

Subscription

Get the list of subscriptions

POST /subscriptions/

DELETE /subscriptions/:subscriptionId

GET /subscriptions/:subscriptionId

PATCH /subscriptions/:subscriptionId

Event

GET /subscriptions/:subscriptionId/events

PATCH /subscriptions/:subscriptionId/events/:eventId

Transaction Data

Register a customer

Find a list of sessions

Create a new session

Get session data

API reference Algoan Pro 2.0.0 Private License