API for creating analyses from PDF bank statements using document extraction technology.
Each requests must be set with an Authorization header using a Bearer JSON Web Token after authenticating with your client credentials.
Authentication
Algoan provides JSON Web Tokens based on the OAuth2 protocol to authenticate your organization.
When you create a new project, you will need to use the service account shared by Algoan containing a client_id and a client_secret.
NOTE: this is the only API where request's parameters are formatted as snake case.
Create a new access token
Generates a new access token to use Algoan's APIs
OAuth2 request body with two grant types - client_credentials and refresh_token
| object | object | Auth request body to generate a new access token | |
| client | string | Your client ID | |
| client | uuid | Your client secret | |
| grant | string | Specify the type of grant access Enum: |
curl --request POST \ --url 'https://api.algoan.com/v1/oauth/token' \ --header 'Authorization: Bearer {token}'Access Token instance
| object | object | ||
| access | string | The access token required for each API. | |
| expires | number | Number of seconds until the access token expires | |
| refresh | number | Number of seconds until the refresh token expires | |
| refresh | string | Refresh token used to generate a new access token | |
| token | string | Type of access token (will always be set to |
{ "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIi...5jUKEv5KyzShp5pqg", "expires_in": 86400, "refresh_expires_in": 864000, "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5...fsWGA82PQC_6OXoyU4", "token_type": "bearer"}Customer
represents a user able to connect/aggregate their bank accounts. It is unique per organization, project and custom identifier.
Create a customer
Creates a new customer instance
New customer to create
| object | object | Information about a customer and its journey through Algoan. | |
| customIdentifier | string | A custom identifier that will be attached to your customer. This can be used to identify a customer based on your internal reference. | |
| aggregationDetails | object | Information about the AIS provider used for this report | |
| 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 | |
| token | string | Temporary access token set for Algoan's UI to communicate with the aggregator's API | |
| 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 | |
| userId | string | Aggregator user identifier If the value is reset, it means the user access has been revoked. | |
| clientId | string | Aggregator client ID used to authenticate a user with your organization | |
| personalDetails | object | Personal information about the customer | |
| nationality | string | Nationality (ISO alpha-2) | |
| firstName | string | First name | |
| lastName | string | Last name | |
| birthName | string | Birth name | |
| birthDate | date | 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. | |
| contact | object | Contact information about a customer | |
| string | Electronic mail address | ||
| phoneNumber | string | Customer's phone number | |
| street | string | ||
| additionalInformation | string | Additional information about the mailing address | |
| city | string | City's mailing address of the customer | |
| zipCode | string | Mailing address zip code of the customer | |
| country | string | Mailing address country of the customer | |
| household | object | Household information about a customer | |
| maritalStatus | string | The marital status of the customer Enum: | |
| numberOfDependentChildren | number | The number of children the customer looks after | |
| numberOfOtherDependents | number | The number of other people the customer is in charge of |
curl --request POST \ --url 'https://api.algoan.com/v2/customers' \ --header 'Authorization: Bearer {token}' \ --data '{ "customIdentifier": "my_id_43523", "aggregationDetails": { "callbackUrl": "{string}", "token": "{string}", "redirectUrl": "{string}", "apiUrl": "{string}", "iframeUrl": "{string}", "userId": "{string}", "clientId": "{string}" }, "personalDetails": { "identity": "{}", "contact": { "email": "test@algoan.com", "phoneNumber": "+33611223344", "street": "151 rue saint denis", "additionalInformation": "second Floor", "city": "Paris", "zipCode": 75002, "country": "FR" }, "household": { "maritalStatus": "CIVIL_PARTNERSHIP", "numberOfDependentChildren": 2, "numberOfOtherDependents": 0 } }}'New customer created
| object | object | Information about a customer and its journey through Algoan. | |
| id | string | Algoan unique identifier | |
| customIdentifier | string | A custom identifier that will be attached to your customer. This can be used to identify a customer based on your internal reference. | |
| aggregationDetails | object | Information about the AIS provider used for this report | |
| aggregatorName | string | Name of the aggregator company Enum: | |
| 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 | |
| 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: | |
| 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 | |
| userId | string | Aggregator user identifier If the value is reset, it means the user access has been revoked. | |
| clientId | string | Aggregator client ID used to authenticate a user with your organization | |
| personalDetails | object | Personal information about the customer | |
| nationality | string | Nationality (ISO alpha-2) | |
| firstName | string | First name | |
| lastName | string | Last name | |
| birthName | string | Birth name | |
| birthDate | date | 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. | |
| contact | object | Contact information about a customer | |
| string | Electronic mail address | ||
| phoneNumber | string | Customer's phone number | |
| street | string | ||
| additionalInformation | string | Additional information about the mailing address | |
| city | string | City's mailing address of the customer | |
| zipCode | string | Mailing address zip code of the customer | |
| country | string | Mailing address country of the customer | |
| household | object | Household information about a customer | |
| maritalStatus | string | The marital status of the customer Enum: | |
| numberOfDependentChildren | number | The number of children the customer looks after | |
| numberOfOtherDependents | number | The number of other people the customer is in charge of | |
| reports | object | Reports about the customer | |
| completedAnalyses | object | Information about analyses related to the customer | |
| count | number | Number of analysis with | |
| date | date-time | Last completed analysis date | |
| url | string | URL of the last analysis | |
| lastFailedAnalysis | object | Information about the last failed analysis of the customer | |
| date | date-time | Last failed analysis date | |
| url | string | URL of the last failed analysis | |
| type | string | Type of the last failed analysis Enum: | |
| userJourneyState | string | The customer most advanced state in the user journey. States:
Enum: | |
| openBankingInformation | object | Information about the customer retrieved from the Open Banking process | |
| owners | array[object] | Owners of the accounts Same names are merged. | |
| name | string | Name of the owner | |
| createdAt | date-time | Customer date of creation | |
| updatedAt | date-time | Latest update of the customer |
Bad request
Unauthorized, please make sure you are properly authenticated
Forbidden, please make sure you are allowed to use this route
Unprocessable Entity
{ "id": "6013d7991496b7395090f05c", "customIdentifier": "my_id_43523", "aggregationDetails": { "aggregatorName": "{string}", "callbackUrl": "{string}", "token": "{string}", "mode": "{string}", "redirectUrl": "{string}", "apiUrl": "{string}", "iframeUrl": "{string}", "userId": "{string}", "clientId": "{string}" }, "personalDetails": { "identity": "{}", "contact": { "email": "test@algoan.com", "phoneNumber": "+33611223344", "street": "151 rue saint denis", "additionalInformation": "second Floor", "city": "Paris", "zipCode": 75002, "country": "FR" }, "household": { "maritalStatus": "CIVIL_PARTNERSHIP", "numberOfDependentChildren": 2, "numberOfOtherDependents": 0 } }, "reports": { "completedAnalyses": { "count": "{number}", "date": "{date-time}", "url": "https://api.algoan.com/v2/customers/customer_id/analyses/analysis_id" }, "lastFailedAnalysis": { "date": "{date-time}", "url": "https://api.algoan.com/v2/customers/customer_id/analyses/analysis_id", "type": "NOT_ENOUGH_TRANSACTIONS" }, "userJourneyState": "CUSTOMER_CREATED" }, "openBankingInformation": { "owners": [ { "name": "John Doe" } ] }, "createdAt": "{date-time}", "updatedAt": "{date-time}"}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.
Create analysis from PDF bank statements
Triggers an analysis creation by extracting transaction and account data from PDF bank statements. This endpoint accepts one or more PDF files containing bank statements, extracts the financial data using document extraction technology, and automatically creates an analysis for the specified customer.
How it works
- Upload one or more PDF bank statements as base64-encoded files
- The system extracts accounts and transactions from the PDFs
- An analysis is automatically created with the extracted data
- The analysis processes the data to generate Score and Credit Insights results
Requirements
- Files must be valid PDF documents containing bank statements
- Each file must be base64-encoded
- The customer must exist before calling this endpoint
Response
The endpoint returns immediately with a 202 Accepted status and the analysisId. The extraction and analysis computation happen asynchronously. You can poll the analysis status or use webhooks to be notified when the analysis is completed.
Array of PDF bank statement files to extract and analyze
| object | object | ||
| files | array[object] | ||
| fileName | string | Name of the PDF bank statement file | |
| base64File | string | Base64-encoded PDF file content |
curl --request POST \ --url 'https://api.algoan.com/v2/customers/{id}/bank-statements' \ --header 'Authorization: Bearer {token}' \ --data '{ "files": [ { "fileName": "bank_statement_january_2025.pdf", "base64File": "JVBERi0xLjQKJeLjz9MKMy..." } ]}'Analysis created and extraction in progress
| object | object | ||
| analysisId | string | Unique identifier of the created analysis |
Bad request - Invalid file format or missing required fields
Unauthorized, please make sure you are properly authenticated
Forbidden, please make sure you are allowed to use this route
Customer not found
{ "analysisId": "5c336adbf675152f00549d6f"}Get an analysis
Get a unique analysis
curl --get \ --url 'https://api.algoan.com/v2/customers/{id}/analyses/{analysisId}' \ --header 'Authorization: Bearer {token}'Analysis instance
| object | object | An analysis launched with open banking data | |
| id | string | Unique analysis identifier | |
| format | string | Original format of the open banking data (default to Enum: Default: ALGOAN | |
| parameters | object | Optional parameters related to the analysis. If | |
| disableScores | boolean | Set to true if you only want to launch a Credit Insights analysis Default: false | |
| disableCreditInsights | boolean | Set to true if you only want to launch the Score Default: false | |
| useBalanceDate | boolean | Set to true if you want to use the most recent account balance date as a reference date for the analysis instead of using the current date Default: false | |
| period | object | Parameters used to compute the analyzed period. | |
| mode | string | Analysis configuration mode:
m and n refer respectively to the value of numberOfDays and numberOfMonths. Enum: | |
| numberOfDays | number | Number of analyzed days. | |
| numberOfMonths | number | Number of analyzed months. | |
| includeCheckingAccountsOnTruncateWindow | boolean | Used if mode is MONTHS_TRUNCATED. If true only the transactions of checking accounts are used to compute analysis window dates. | |
| isComputedUsingProjectConfig | boolean | Whether the analyzed period has been computed using the project's configurations or the values in period | |
| launchReport | boolean | Set to true if you want to automatically launch a report creation after the analysis is completed. You will be notified on your webhook when the report status is COMPLETED (or ERROR). Default: false | |
| status | string | State of the analysis:
Enum: | |
| source | string | Describes the origin of the analysis' launch:
Enum: | |
| dataOrigin | string | Describes the origin of the analysis' data:
Enum: | |
| createdAt | date-time | Analysis date of creation | |
| updatedAt | date-time | Latest update of the analysis | |
| metadata | object | Indicators about the Open Banking data used to execute the Analysis. Deprecated properties correspond to Credit Insights indicators. | |
| referenceDate | date-time | Reference date of the analysis | |
| numberOfCheckings | number | Number of checking accounts | |
| numberOfSavings | number | Number of saving accounts | |
| numberOfLoans | number | Number of loan accounts | |
| numberOfCreditCard | number | Number of credit card accounts | |
| creditInsights | object | Indicators about the Open Banking data used to compute the Credit Insights product | |
| lastTransactionGap | number | Number of days between the call to the product calculation and the last transaction | |
| historicalDepth | number | Number of days between the first and last transaction on the union of CHECKING and CREDIT_CARD accounts | |
| monthlyTransactionCount | number | Monthly mean number of transactions | |
| firstTransactionDate | date-time | Date of the oldest transaction | |
| calendar | array[object] | ||
| month | string | calendar month of the history | |
| nbDays | number | Number of days of the month covered in the banking history. Allows to know which months are truncated. | |
| totalTransactionCount | number | Total number of analysed transactions | |
| minWindowDate | date | Date of the oldest transaction used to compute the product | |
| maxWindowDate | date | Date of the most recent transaction used to compute the product | |
| numberOfDaysInWindow | number | Number of days of the window of transactions used to compute the product | |
| creditScore | object | Indicators about the Open Banking data used to compute the Credit Score product | |
| lastTransactionGap | number | Number of days between the call to the product calculation and the last transaction | |
| historicalDepth | number | Number of days between the first and last transaction on the union of CHECKING and CREDIT_CARD accounts | |
| monthlyTransactionCount | number | Monthly mean number of transactions | |
| firstTransactionDate | date-time | Date of the oldest transaction | |
| calendar | array[object] | ||
| month | string | calendar month of the history | |
| nbDays | number | Number of days of the month covered in the banking history. Allows to know which months are truncated. | |
| totalTransactionCount | number | Total number of analysed transactions | |
| minWindowDate | date | Date of the oldest transaction used to compute the product | |
| maxWindowDate | date | Date of the most recent transaction used to compute the product | |
| numberOfDaysInWindow | number | Number of days of the window of transactions used to compute the product | |
| paymentScore | object | Indicators about the Open Banking data used to compute the Payment Score product | |
| lastTransactionGap | number | Number of days between the call to the product calculation and the last transaction | |
| historicalDepth | number | Number of days between the first and last transaction on the union of CHECKING and CREDIT_CARD accounts | |
| monthlyTransactionCount | number | Monthly mean number of transactions | |
| firstTransactionDate | date-time | Date of the oldest transaction | |
| calendar | array[object] | ||
| month | string | calendar month of the history | |
| nbDays | number | Number of days of the month covered in the banking history. Allows to know which months are truncated. | |
| totalTransactionCount | number | Total number of analysed transactions | |
| minWindowDate | date | Date of the oldest transaction used to compute the product | |
| maxWindowDate | date | Date of the most recent transaction used to compute the product | |
| numberOfDaysInWindow | number | Number of days of the window of transactions used to compute the product | |
| lastTransactionGap | number | Number of days between the call Credit Insights and the last transaction Deprecated | |
| historicalDepth | number | Number of days between the first and last transaction on the union of CHECKING and CREDIT_CARD accounts Deprecated | |
| monthlyTransactionCount | number | Monthly mean number of transactions Deprecated | |
| firstTransactionDate | date-time | Date of the oldest transaction Deprecated | |
| calendar | array[object] | Deprecated | |
| month | string | calendar month of the history Deprecated | |
| nbDays | number | Number of days of the month covered in the banking history. Allows to know which months are truncated. Deprecated | |
| totalTransactionCount | number | Total number of analysed transactions Deprecated | |
| activityScore | 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 | Ranges from 1 to 100, and it can be interpreted as follows:
| |
| numberOfDaysInWindow | number | Number of analysed days. | |
| calendar | array[object] | ||
| month | string | calendar month of the history | |
| nbDays | number | Number of days of the month covered in the banking history. Allows to know which months are truncated. | |
| creditInsights | object | Object containing results from Credit Insights | |
| version | string | Credit Insights' version | |
| cashFlows | array[object] | All cash flows used to launch the analysis | |
| type | string | Enum: | |
| category | This is the list of all possible transactions categories. Some of them are not currently implemented yet. To have a detailed list, ask your Customer Success Manager. | ||
| string | string | Enum: | |
| labelRoot | string | Common description root shared by the transactions within the same Cashflow | |
| label | string | This value differs from labelRoot when a Cashflow can be split into two smaller pieces. These pieces share similarities in terms of amount and dates | |
| totalAmount | number | Total amount of the cash flow over the period of analysis. Transactions that are or has been rejected are included in this sum. Negative if expense, positive if income. | |
| totalRejectedAmount | number | Total amount of the rejected transactions of the cash flow over the period. | |
| calendar | array[object] | ||
| month | string | Calendar month of the transaction | |
| amount | number | Negative if expense, positive if income. | |
| transactions | array[object] | Concerned transactions | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| regularity | object | Regularity information about the cashflow only present when the cashflow is detected as regular | |
| dueDays | array[number] | Expected day of the occurrence of the cashflow | |
| interval | object | Interval of regularity | |
| min | number | Minimum regularity interval (in days) possible | |
| max | number | Maximum regularity interval (in days) possible | |
| meanNumberOfDaysInInterval | number | Mean number of days in the interval of regularity | |
| accuracy | number | Percentage of accuracy of the interval of regularity | |
| periodicity | string | Type of periodicity of the regularity Enum: | |
| repartition | string | Type of repartition of the transactions on the cash flow Enum: | |
| incomes | object | Information about user's incomes | |
| totalAmount | number | Total amount of incomes | |
| monthlyAmount | number | Mean income per month | |
| indicators | object | Ratios and indicators about the customer’s incomes | |
| allowancesRatio | number | Proportion of allowances in incomes maximum: 1 minimum: 0 | |
| employers | array[object] | ||
| name | string | Company name. | |
| staffing | string | Code describing the range of employees' number in the company :
Enum: | |
| categories | array[object] | Transactions grouped by category | |
| name | string | Enum: | |
| totalAmount | number | Total amount of the cash flow over the period of analysis. As income, it is positive. | |
| monthlyAmount | number | Mean amount per month | |
| monthlyAmountExcludingMonthsWithoutValues | number | Mean income per month excluding the months without values | |
| calendar | array[object] | ||
| month | string | Calendar month of the transaction | |
| amount | number | Total amount of the cash flow during the month. As income, it is positive. | |
| transactions | array | Concerned transactions | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| enrichments | object | Properties computed by Algoan | |
| category | string | Value computed by Credit Insights. This property describes the reason why a transaction is made. Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. | |
| employer | object | Company identified as paying wages to the customer. | |
| name | string | Company name. | |
| staffing | string | Code describing the range of employees' number in the company :
Enum: | |
| expenses | object | Information about user's expenses | |
| totalAmount | number | Total amount of detected expenses | |
| monthlyAmount | number | Mean amount of expenses per month | |
| frequentTransactions | array[object] | List of transaction groups that share the same common transaction description. A transaction group is created when there are at least 5 occurrences of transactions that share the same description over the period of analysis. | |
| label | string | label of the group | |
| transactions | array[object] | Transactions belonging to the group | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| categories | array[object] | ||
| name | string | Enum: | |
| totalAmount | number | Total amount of the cash flow over the period of analysis. As expense, it is negative. | |
| monthlyAmount | number | Mean amount per month | |
| monthlyAmountExcludingMonthsWithoutValues | number | Mean expenses per month excluding the months without values | |
| calendar | array[object] | ||
| month | string | Calendar month of the transaction | |
| amount | number | Total amount of the cash flow during the month. As expense, it is negative. | |
| transactions | array | Concerned transactions | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| enrichments | object | Properties computed by Algoan | |
| category | string | Value computed by Credit Insights. This property describes the reason why a transaction is made. Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. | |
| loans | object | Information about user's loans | |
| repayments | object | Information about loan repayments. This section does not take into account rejected loan repayment. | |
| totalAmount | number | Total amount of all detected repayments over the period of analysis | |
| monthlyAmount | number | Mean amount of loan repayments per month | |
| monthlyAmountExcludingMonthsWithoutValues | number | Mean loan repayment amount per month excluding the months without values | |
| lendingOrganizations | array[object] | Detected lending organizations in loan repayments. | |
| name | string | lender's name. | |
| details | array | All cash flows related to loan repayments | |
| type | string | Enum: | |
| labelRoot | string | Common description root shared by the transactions within the same Cashflow | |
| label | string | This value differs from labelRoot when a Cashflow can be split into two smaller pieces. These pieces share similarities in terms of amount and dates | |
| totalAmount | number | Total amount of the cash flow over the period of analysis. Transactions that are or has been rejected are included in this sum. Negative if expense, positive if income. | |
| totalRejectedAmount | number | Total amount of the rejected transactions of the cash flow over the period. | |
| calendar | array[object] | ||
| month | string | Calendar month of the transaction | |
| amount | number | Negative if expense, positive if income. | |
| regularity | object | Regularity information about the cashflow only present when the cashflow is detected as regular | |
| dueDays | array[number] | Expected day of the occurrence of the cashflow | |
| interval | object | Interval of regularity | |
| min | number | Minimum regularity interval (in days) possible | |
| max | number | Maximum regularity interval (in days) possible | |
| meanNumberOfDaysInInterval | number | Mean number of days in the interval of regularity | |
| accuracy | number | Percentage of accuracy of the interval of regularity | |
| periodicity | string | Type of periodicity of the regularity Enum: | |
| repartition | string | Type of repartition of the transactions on the cash flow Enum: | |
| category | string | Enum: | |
| transactions | array | Concerned transactions | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| enrichments | object | Properties computed by Algoan | |
| category | string | Value computed by Credit Insights. This property describes the reason why a transaction is made. Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. | |
| lendingOrganization | object | ||
| name | string | lender's name. | |
| drawdowns | object | Information about loan drawdowns | |
| count | number | Number of concerned transactions | |
| totalAmount | number | Total amount of drawdowns | |
| monthlyAmount | number | Mean amount of loan drawdowns per month | |
| monthlyAmountExcludingMonthsWithoutValues | number | Mean loan drawdowns amount per month excluding the months without values | |
| lendingOrganizations | array[object] | Detected lending organizations in loan drawdowns. | |
| name | string | lender's name. | |
| details | array | All cash flows related to loan drawdowns | |
| type | string | Enum: | |
| labelRoot | string | Common description root shared by the transactions within the same Cashflow | |
| label | string | This value differs from labelRoot when a Cashflow can be split into two smaller pieces. These pieces share similarities in terms of amount and dates | |
| totalAmount | number | Total amount of the cash flow over the period of analysis. Transactions that are or has been rejected are included in this sum. Negative if expense, positive if income. | |
| totalRejectedAmount | number | Total amount of the rejected transactions of the cash flow over the period. | |
| calendar | array[object] | ||
| month | string | Calendar month of the transaction | |
| amount | number | Negative if expense, positive if income. | |
| regularity | object | Regularity information about the cashflow only present when the cashflow is detected as regular | |
| dueDays | array[number] | Expected day of the occurrence of the cashflow | |
| interval | object | Interval of regularity | |
| min | number | Minimum regularity interval (in days) possible | |
| max | number | Maximum regularity interval (in days) possible | |
| meanNumberOfDaysInInterval | number | Mean number of days in the interval of regularity | |
| accuracy | number | Percentage of accuracy of the interval of regularity | |
| periodicity | string | Type of periodicity of the regularity Enum: | |
| repartition | string | Type of repartition of the transactions on the cash flow Enum: | |
| category | string | Enum: | |
| transactions | array | Concerned transactions | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| enrichments | object | Properties computed by Algoan | |
| category | string | Value computed by Credit Insights. This property describes the reason why a transaction is made. Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. | |
| lendingOrganization | object | ||
| name | string | lender's name. | |
| risks | object | All indicators helping to make a decision | |
| gambling | object | User's gambling behavior indicators. This section does not take into account rejected loan repayment. | |
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| incidents | object | ||
| paymentRejections | object | ||
| totalAmount | number | Total amount of detected rejected transactions. If a direct debit is rejected twice, it will be counted twice. | |
| totalFeesAmount | number | Total amount of fees due to payment rejection. | |
| transactions | array[object] | Detected rejected transaction. | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| feesTransactions | array[object] | Detected rejection fees. They may be disassociated from the rejections transaction as some rejections can be charged month after. | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| checkRejections | object | ||
| totalAmount | number | Total amount of the related transactions. | |
| totalFeesAmount | number | Total amount of fees due to check rejection. | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| feesTransactions | array[object] | Detected check rejection fees. They may be disassociated from the rejections transaction as some rejections can be charged month after. | |
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| interventionFees | object | These fees may occur when a bank charge its user when a operator has to intervene on the account. Usually this occurs after a payment rejection. | |
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| overdraft | object | User's overdraft behaviour. | |
| minimumBalanceReached | number | Lowest balance detected | |
| duration | number | Number of days in overdraft. This number is the sum of all overdraft period. | |
| fees | object | Overdrafts fees transaction detail | |
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| heavyFailures | object | Events that occurs after either a juridic decision or when an institution fetch its due directly on the users account. | |
| directRecoveryOfDebt | object | ||
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| bankAccountSeizure | object | ||
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| wageAdvance | object | ||
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| debtCollection | object | Repayment recovered by a specialized organization (for litigations/defaulted payments) | |
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| bailiff | object | Payment recovered by a bailiff | |
| totalAmount | number | Total amount of the related transactions | |
| transactions | array[object] | ||
| id | string | Unique transaction identifier | |
| accountId | string | Algoan's account identifier | |
| description | string | Description of the transaction. If description is an empty string, a 400 HTTP error will be returned. | |
| dates | object | Dates associated with the transaction. At least one date is required, depending on the type of account. For instance, if it is a "checking" account, the "debitedAt" date is required. | |
| debitedAt | date-time | Debit date as seen on the bank statement. This property may not be set if the transaction is not yet debited. This can occurs if there's a differed payement. | |
| bookedAt | date-time | Realization date of the transaction | |
| amount | number | Amount of the transaction (negative if debit) | |
| currency | string | Transaction's currency Default: EUR | |
| enrichments | object | Properties computed by Algoan | |
| category | Value computed by Credit Insights. This property describes the reason why a transaction is made. | ||
| string | string | Enum: | |
| type | string | Value computed by Credit Insights. This property describes the mode of transaction. Enum: | |
| isInternationalTransfer | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been transferred to or from a country other than the one specified in Credit Insights configuration. | |
| isRejected | boolean | Boolean computed by Credit Insights. Indicates if the transaction has been rejected or not. Deprecation notice: will be removed, instead use
Deprecated | |
| counterPartId | string | Value computed by Credit Insights. Identifier of the counterpart transaction if the transaction is or has been rejected. Deprecation notice: will be removed, instead use
Deprecated | |
| relatedTransactions | object | List of identifiers related to this transaction. The nature of relationship between one transaction and its relatives can be split into 5 natures:
| |
| retryOf | string | Id corresponding to the rejected transaction being retried by this transaction Flexible link | |
| retriedOn | string | Id of the transaction corresponding to the retry of this rejected 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 (positive transaction) of this rejected transaction Robust link | |
| transferOf | string | Id of the outgoing internal transfer transaction (negative amount) resulting in this incoming internal transfer transaction Robust link | |
| transferredOn | string | Id of the incoming internal transfer transaction (positive amount) corresponding to this outgoing internal transfer transaction Robust link | |
| resetOf | string | Id of the deferred payment transaction on a CHECKING account this transaction is resulting from on a CREDIT_CARD account Robust link | |
| resetOn | string | Id of the credit card reset transaction on a CREDIT_CARD account resulting from this deferred payment transaction occurring on a CHECKING account Robust link | |
| refundOf | string | Id of the initial payment transaction that is refunded by this transaction Robust link | |
| refundedOn | string | Id of the refund transaction (positive amount) corresponding to this transaction (negative amount) Robust link | |
| isComing | boolean | Indicates if the transaction will be debited or credited on the account in the future | |
| aggregator | object | Additional information relative to the transaction provided by the aggregator | |
| id | string | id of the transaction provided by the aggregator | |
| isNonAnalysed | boolean | Indicates if the transaction is included in the last generated analysis | |
| scores | object | Scores assessing the probability of default Depending on your Score configuration you can have one or many scores computed. Each score will be billed independently. | |
| creditScore | object | default score with a 12-month horizon | |
| version | string | Score's version | |
| value | number | Between 0 and 1000. 0 is risky, 1000 is safe. This number is a transformation of the probability of default that is usually set between 0 and 1 (where 0 is safe and 1 is risky) maximum: 1000 minimum: 0 | |
| indicators | object | Indicators about credit score behavior. These values reflect the behavior of the score in a way that is comprehensible for the human eye. Each of them is like an axis where the value varies from -5 to 5. The combination of these numbers is correlated to the score value. A negative value means the axis impacts the score value in a bad way where a positive value can inflate the score value. This representation is a mirror of Algoan Score. Its objective is to provide keys to an understanding of Score for a specific customer. | |
| paymentScore | object | default score with a 4-month horizon | |
| version | string | Score's version | |
| value | number | Between 1 and 10. 1 is risky, 10 is safe. This number represents the interval of risk. It's based on a transformation of the probability of default maximum: 10 minimum: 1 | |
| error | object | This property is defined if the analysis is in an | |
| code | string | Description :
Enum: | |
| message | string | A human readable error message |
Bad request
Unauthorized, please make sure you are properly authenticated
Forbidden, please make sure you are allowed to use this route
Analysis not found
{ "id": "{string}", "format": "{string}", "parameters": {...}, "status": "{string}", "source": "{string}", "dataOrigin": "{string}", "createdAt": "{date-time}", "updatedAt": "{date-time}", "metadata": {...}, "creditInsights": {...}, "scores": {...}, "error": {...}}