{"swagger":"2.0","info":{"title":"FriendlyScore Public API","description":"Public API for communication with FriendlyScore","version":"v1"},"paths":{"\/public\/v3\/customers\/{customer_id}\/affordability\/{account_type}":{"get":{"summary":"Get Customer Affordability Collection.","description":"Customer Affordability is measured for the 12 months period excluding current month","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_type","in":"path","required":true,"description":"Bank Account type: possibile values Personal or Business","type":"string","pattern":"personal"}],"responses":{"200":{"description":"Returns a `AffordabilityCollection`","schema":{"$ref":"#\/definitions\/AffordabilityCollection"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/affordability\/{account_type}\/weights":{"get":{"summary":"Get Customer Affordability Weights Collection.","description":"Customer Affordability Weights are defined in Dashboard and modify the weights for categories","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_type","in":"path","required":true,"description":"Bank Account type: possibile values Personal or Business","type":"string","pattern":"personal"}],"responses":{"200":{"description":"Returns a `AffordabilityWeightCollection`","schema":{"$ref":"#\/definitions\/AffordabilityWeightCollection"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/allowed-redirect-urls":{"get":{"summary":"Get Allowed Redirect Urls","responses":{"200":{"description":"Returns an array of Allowed Redirect Url"},"400":{"description":"JSON with validation errors e.g. missing required fields"}},"tags":["12. Custom Web Flow"],"security":[{"Bearer":[]}]},"post":{"summary":"Post new Allowed Redirect Url","parameters":[{"name":"body","in":"body","description":"Init data","schema":{"$ref":"#\/definitions\/AllowedRedirectUrl"}}],"responses":{"200":{"description":"Returns Allowed Redirect ID","schema":{"$ref":"#\/definitions\/AllowedRedirectUrl"}},"400":{"description":"JSON with validation errors e.g. missing required fields"}},"tags":["12. Custom Web Flow"],"security":[{"Bearer":[]}]}},"\/public\/v3\/allowed-redirect-urls\/{id}\/delete":{"delete":{"summary":"Delete a Allowed Redirect Url","parameters":[{"name":"id","in":"path","required":true,"description":"Allowed Redirect Url\u0027s ID","type":"string"}],"responses":{"200":{"description":"Returns status message"},"404":{"description":"Not found"}},"tags":["12. Custom Web Flow"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers":{"get":{"summary":"Get Customers","parameters":[{"name":"by-user-reference","in":"query","allowEmptyValue":false,"required":false,"description":"Filter by user identifier from **your** database","type":"string"}],"responses":{"200":{"description":"Returns array of `User` objects","schema":{"$ref":"#\/definitions\/UserCollection"}},"404":{"description":"Not found"}},"tags":["02. Customers"],"security":[{"Bearer":[]}]},"post":{"summary":"Create Customer","parameters":[{"name":"user_data","in":"body","description":"Data to insert","schema":{"$ref":"#\/definitions\/UserReferenceWithEntityType"}}],"responses":{"200":{"description":"Returns the created `User` object","schema":{"$ref":"#\/definitions\/User"}},"400":{"description":"JSON with validation errors"}},"tags":["02. Customers"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/delete":{"delete":{"summary":"Delete Customer","parameters":[{"name":"customer_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Returns status"},"400":{"description":"JSON with validation errors"}},"tags":["02. Customers"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/token":{"post":{"summary":"Get ApplicationUserToken for Customer","description":"ApplicationUserToken is used in Mobile SDK and Customer Webflow","parameters":[{"name":"customer_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Return ApplicationUserToken used in communication for Mobile SDK"},"404":{"description":"Not found"}},"tags":["02. Customers"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/account-connect":{"post":{"summary":"Get URL for AISP Bank Connect","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"404":{"description":"Not found"}},"tags":["10. Web Component"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/cashflow\/{account_type}":{"get":{"parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_type","in":"path","required":true,"description":"Bank Account type: possibile values Personal or Business","type":"string","pattern":"personal|business"}],"responses":{"200":{"description":"Returns a `CashflowCollection`","schema":{"$ref":"#\/definitions\/CashflowCollection"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/component_auth\/init":{"post":{"summary":"Get a one-time url to render the FriendlyScore WebComponent","parameters":[{"name":"body","in":"body","description":"Init data","schema":{"$ref":"#\/definitions\/ComponentInitRequest"}}],"responses":{"200":{"description":"Returns `ComponentInitResponse` with one time url","schema":{"$ref":"#\/definitions\/ComponentInitResponse"}},"400":{"description":"JSON with validation errors e.g. not using user_reference in a phoneless flow or vice versa,\n     *     missing required fields"}},"tags":["10. Web Component"]}},"\/public\/v3\/customers\/{customer_id}\/events\/{account_type}":{"get":{"summary":"Get Customer Events Collection.","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_type","in":"path","required":true,"description":"Bank Account type: only personal account type is supported","type":"string"}],"responses":{"200":{"description":"Returns a `EventCollection`","schema":{"$ref":"#\/definitions\/EventCollection"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/account_collections":{"post":{"summary":"Post Bank Accounts","parameters":[{"name":"accounts_collection","in":"body","description":"AccountInputCollection object","schema":{"$ref":"#\/definitions\/AccountInputCollection"}},{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"204":{"description":"Collection has been stored successfully"},"400":{"description":"JSON with validation errors"}},"tags":["04. Post your own data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/accounts":{"get":{"summary":"Get Accounts","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns a collection of bank accounts","schema":{"$ref":"#\/definitions\/AccountCollection"}}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/balance_collections":{"post":{"summary":"Post Bank Balances","parameters":[{"name":"balances_collection","in":"body","description":"BalanceInputCollection object","schema":{"$ref":"#\/definitions\/BalanceInputCollection"}},{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"202":{"description":"Returns `DtnDataProcessingSummary`","schema":{"$ref":"#\/definitions\/DtnDataProcessingSummary"}},"400":{"description":"JSON with validation errors"}},"tags":["04. Post your own data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/transaction_collections":{"post":{"summary":"Post Bank Transactions","parameters":[{"name":"transactions_collection","in":"body","description":"TransactionInputCollection object","schema":{"$ref":"#\/definitions\/TransactionInputCollection"}},{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"202":{"description":"Returns `DtnDataProcessingSummary`","schema":{"$ref":"#\/definitions\/DtnDataProcessingSummary"}},"400":{"description":"JSON with validation errors"}},"tags":["04. Post your own data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/balances":{"get":{"summary":"Get Balances","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns a collection of bank balances","schema":{"$ref":"#\/definitions\/BalanceCollection"}}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/banks":{"get":{"summary":"Get Banks","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns customer\u0027s banks with embedded consent objects","schema":{"$ref":"#\/definitions\/BankWithConsentsCollection"}},"404":{"description":"Returns 404 when customer is not found"}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/bank\/{bank_slug}\/consent\/{consent_type}":{"get":{"summary":"Get Consent for Bank","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"consent_type","in":"path","required":true,"description":"Identifier of the consent type. Currently only `\u0027account\u0027` is used.","type":"string"},{"name":"bank_slug","in":"path","required":true,"description":"Identifier of the bank. Bank slug","type":"string"}],"responses":{"200":{"description":"Returns the consent object","schema":{"$ref":"#\/definitions\/ConsentData"}},"404":{"description":"Returns not found when there is no consent"}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/bank\/{bank_slug}\/consent\/{consent_type}\/reconfirmation":{"post":{"summary":"Customer reconfirmation of the Consent for Bank","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"consent_type","in":"path","required":true,"description":"Identifier of the consent type. Currently only `\u0027account\u0027` is used.","type":"string"},{"name":"bank_slug","in":"path","required":true,"description":"Identifier of the bank. Bank slug","type":"string"}],"responses":{"200":{"description":"Returns the reconfirmation consent object","schema":{"$ref":"#\/definitions\/ConsentReconfirmationData"}},"404":{"description":"Returns not found when there is no consent"}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/accounts\/{account_id}\/party":{"get":{"summary":"Get Account Parties","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_id","in":"path","required":true,"description":"Account ID","type":"string"}],"responses":{"200":{"description":"Returns a collection of bank accounts","schema":{"$ref":"#\/definitions\/PartyCollection"}}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/accounts\/{account_id}\/statements":{"get":{"summary":"Get Account Statements","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_id","in":"path","required":true,"description":"Account ID","type":"string"}],"responses":{"200":{"description":"Returns a collection of bank statements","schema":{"$ref":"#\/definitions\/StatementCollection"}}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/transaction_categorisation\/{account_type}":{"patch":{"summary":"Update Category for Transactions","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"account_type","in":"path","required":true,"description":"Account type: `Personal` or `Business`","type":"string"},{"name":"category_patch","in":"body","description":"Object describing which transactions should be patched and what category should be set.","schema":{"$ref":"#\/definitions\/TransactionsCategoryPatch"}}],"responses":{"204":{"description":"Transaction categories have been updated successfully"},"400":{"description":"JSON with validation errors"}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/transactions":{"get":{"summary":"Get Transactions","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"page","in":"query","description":"Page number (1 by default)","type":"integer"},{"name":"max_per_page","in":"query","description":"Item count on one page (1000 by default)","type":"integer"},{"name":"category_id","in":"query","description":"Category ID to filter by","type":"string"},{"name":"account_number","in":"query","description":"Account number to filter by","type":"string"},{"name":"account_type","in":"query","description":"OpenBanking Account type (`\u0027Personal\u0027` or `\u0027Business\u0027`)","type":"string"},{"name":"bank_slug","in":"query","description":"Bank slug to filter by","type":"string"},{"name":"booking_date_time_from","in":"query","description":"Min value (inclusive) for booking date time filter (UNIX timestamp in seconds)","type":"integer"},{"name":"booking_date_time_to","in":"query","description":"Max value (inclusive) for booking date time filter (UNIX timestamp in seconds)","type":"integer"},{"name":"currency","in":"query","description":"Currency to filter by (ISO 4217 format)","type":"string"}],"responses":{"200":{"description":"Returns a collection of bank transactions","schema":{"$ref":"#\/definitions\/TransactionCollection"}},"400":{"description":"JSON with validation errors (query filters are validated and check for illegal values)"}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/raw-transactions":{"get":{"summary":"Get Transactions","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"page","in":"query","description":"Page number (1 by default)","type":"integer"},{"name":"max_per_page","in":"query","description":"Item count on one page (1000 by default)","type":"integer"},{"name":"category_id","in":"query","description":"Category ID to filter by","type":"string"},{"name":"account_number","in":"query","description":"Account number to filter by","type":"string"},{"name":"account_type","in":"query","description":"OpenBanking Account type (`\u0027Personal\u0027` or `\u0027Business\u0027`)","type":"string"},{"name":"bank_slug","in":"query","description":"Bank slug to filter by","type":"string"},{"name":"booking_date_time_from","in":"query","description":"Min value (inclusive) for booking date time filter (UNIX timestamp in seconds)","type":"integer"},{"name":"booking_date_time_to","in":"query","description":"Max value (inclusive) for booking date time filter (UNIX timestamp in seconds)","type":"integer"},{"name":"currency","in":"query","description":"Currency to filter by (ISO 4217 format)","type":"string"}],"responses":{"200":{"description":"Returns a collection of bank transactions","schema":{"$ref":"#\/definitions\/TransactionCollection"}},"400":{"description":"JSON with validation errors (query filters are validated and check for illegal values)"}},"tags":["05. Customer banking data"],"security":[{"Bearer":[]}]}},"\/public\/v3\/banks":{"get":{"summary":"Get Banks","responses":{"200":{"description":"Returns an array of available banks","schema":{"$ref":"#\/definitions\/BankCollection"}}},"tags":["03. Banks and Categories"],"security":[{"Bearer":[]}]}},"\/public\/v3\/account_types\/{account_type}\/transaction_categories":{"get":{"summary":"Get Categories","parameters":[{"name":"account_type","in":"path","required":true,"description":"Account type: `Personal` or `Business`","type":"string"}],"responses":{"200":{"description":"Returns a `CategoryMetadata` object collection","schema":{"items":{"$ref":"#\/definitions\/CategoryMetadata"},"type":"array"}},"404":{"description":"Not found"}},"tags":["03. Banks and Categories"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/forecasts\/{forecast_id}":{"get":{"summary":"Get Forecasts","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"forecast_id","in":"path","required":true,"description":"ID of the forecast. Should be `current_personal` or `current_business`.","type":"string"}],"responses":{"200":{"description":"Returns a `Forecast`","schema":{"$ref":"#\/definitions\/Forecast"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/insights\/current":{"get":{"summary":"Get Insights for personal accounts","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns an `Insights` object for customer\u0027s personal accounts","schema":{"$ref":"#\/definitions\/Insights"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/insights\/current_personal":{"get":{"summary":"Get Insights for personal accounts","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns an `Insights` object for customer\u0027s personal accounts","schema":{"$ref":"#\/definitions\/Insights"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/insights\/current_business":{"get":{"summary":"Get Insights for business accounts","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns an `Insights` object for customer\u0027s business accounts","schema":{"$ref":"#\/definitions\/BusinessInsights"}},"404":{"description":"Not found"}},"tags":["06. Customer Data Enrichment"],"security":[{"Bearer":[]}]}},"\/public\/v3\/invitations":{"get":{"summary":"Get invitations","parameters":[{"name":"page","in":"query","description":"Page (default is 1)","type":"integer"},{"name":"max_per_page","in":"query","description":"Max results per page (deafult is 1000)","type":"integer"},{"name":"is_used","in":"query","description":"0|1","type":"integer"},{"name":"is_revoked","in":"query","description":"0|1","type":"integer"},{"name":"is_expired","in":"query","description":"0|1","type":"integer"},{"name":"customer_type","in":"query","description":"Business|Personal","type":"string"},{"name":"reference","in":"query","description":"Customer reference","type":"string"}],"responses":{"200":{"description":"Returns an array of CustomerInvitation\u0027s","schema":{"$ref":"#\/definitions\/CustomerInvitationCollection"}},"400":{"description":"JSON with validation errors e.g. missing required fields"}},"tags":["08. Invitation"],"security":[{"Bearer":[]}]},"post":{"summary":"Post new invitation","parameters":[{"name":"body","in":"body","description":"Init data","schema":{"$ref":"#\/definitions\/CustomerInvitationType"}}],"responses":{"200":{"description":"Returns CustomerInvitation","schema":{"$ref":"#\/definitions\/CustomerInvitation"}},"400":{"description":"JSON with validation errors e.g. missing required fields"}},"tags":["08. Invitation"],"security":[{"Bearer":[]}]}},"\/public\/v3\/invitations\/{id}\/revoke":{"patch":{"summary":"Revoke an invitation","parameters":[{"name":"id","in":"path","required":true,"description":"Invitation\u0027s ID","type":"string"}],"responses":{"204":{"description":"Returns an empty response"},"404":{"description":"Not found"}},"tags":["08. Invitation"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/data_processing_statuses\/{dtn_slug}":{"get":{"summary":"ENDPOINT IS DEPRECATED: Get Data Processing Status","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"dtn_slug","in":"path","required":true,"description":"Data Processing Request slug","type":"string"}],"responses":{"200":{"description":"ENDPOINT IS DEPRECATED","schema":{"$ref":"#\/definitions\/DtnDataProcessingSummary"}},"404":{"description":"Not found"}},"tags":["09. Utils"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/data_processing_statuses":{"get":{"summary":"ENDPOINT IS DEPRECATED: Get Data Processing Status list","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"ENDPOINT IS DEPRECATED","schema":{"$ref":"#\/definitions\/DtnDataProcessingSummaryCollection"}}},"tags":["09. Utils"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/report_readiness_statuses\/{report_name}":{"get":{"summary":"Get Report status","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"},{"name":"report_name","in":"path","required":true,"description":"Name of the report (e.g. `insights` or `forecast`)","type":"string"}],"responses":{"200":{"description":"Returns a `ReportReadinessStatus`","schema":{"$ref":"#\/definitions\/ReportReadinessStatus"}},"404":{"description":"Not found"}},"tags":["07. Report Status"],"security":[{"Bearer":[]}]}},"\/public\/v3\/customers\/{customer_id}\/report_readiness_statuses":{"get":{"summary":"Get Report status list","parameters":[{"name":"customer_id","in":"path","required":true,"description":"Customer ID","type":"string"}],"responses":{"200":{"description":"Returns a collection of `ReportReadinessStatus` (all for current authenticated user)","schema":{"$ref":"#\/definitions\/ReportReadinessStatusCollection"}}},"tags":["07. Report Status"],"security":[{"Bearer":[]}]}},"\/public\/v3\/webflow\/banks":{"get":{"summary":"Get Banks for a customer.","parameters":[{"name":"status","in":"query","allowEmptyValue":false,"required":true,"description":"Filter to choose only banks that have certain relation with given user. Default: `\u0027available\u0027`","type":"string","default":"all","enum":["available","connected","all"]}],"responses":{"200":{"description":"Returns collection of `UserBank` objects (with bank data and additional user-relevant data). Bear in mind that transactions_consent_from and transactions_consent_to fields refer to the default values assigned in bank configuration, not current values taken from user\u0027s consent (there\u0027s a separate endpoint for that).","schema":{"items":{"$ref":"#\/definitions\/UserBank"},"type":"array"}},"404":{"description":"Not found"}},"tags":["12. Custom Web Flow"],"security":[{"AppUserToken":[]}]}},"\/public\/v3\/webflow\/banks\/{bank_slug}\/consent":{"post":{"summary":"Get a consent screen description","parameters":[{"name":"bank_slug","in":"path","required":true,"description":"Bank slug","type":"string"},{"name":"transactionFromDateTime","in":"query","description":"Timestamp. You may omit this parameter (default values for bank will be used)","type":"integer"},{"name":"transactionToDateTime","in":"query","description":"Timestamp. You may omit this parameter (default values for bank will be used)","type":"integer"}],"responses":{"200":{"description":"Returns a `ConsentScreen`","schema":{"$ref":"#\/definitions\/ConsentScreen"}},"404":{"description":"Not found"}},"tags":["12. Custom Web Flow"],"security":[{"AppUserToken":[]}]}},"\/public\/v3\/webflow\/banks\/{bankSlug}\/consent\/status":{"get":{"summary":"Get the current user consent for given bank","parameters":[{"name":"bankSlug","in":"path","required":true,"description":"Identifier of the bank. Bank slug","type":"string"}],"responses":{"200":{"description":"Returns the consent object","schema":{"$ref":"#\/definitions\/ConsentData2"}},"204":{"description":"Returns empty response when there was no consent yet"}},"tags":["12. Custom Web Flow"],"security":[{"AppUserToken":[]}]}},"\/public\/v3\/webflow\/banks\/{bankSlug}\/consent\/delete":{"delete":{"summary":"Delete user Consent.","parameters":[{"name":"bankSlug","in":"path","required":true,"description":"Identifier of the bank. Bank slug","type":"string"}],"responses":{"200":{"description":"Returns success\/error status array"}},"tags":["12. Custom Web Flow"],"security":[{"AppUserToken":[]}]}},"\/public\/v3\/webhooks":{"get":{"summary":"Get webhooks","responses":{"200":{"description":"Returns an array of webhooks"},"400":{"description":"JSON with validation errors e.g. missing required fields"}},"tags":["11. Webhooks"],"security":[{"Bearer":[]}]},"post":{"summary":"Post new Webhook","parameters":[{"name":"body","in":"body","description":"Init data","schema":{"$ref":"#\/definitions\/Webhook"}}],"responses":{"200":{"description":"Returns Webhook","schema":{"$ref":"#\/definitions\/Webhook"}},"400":{"description":"JSON with validation errors e.g. missing required fields"}},"tags":["11. Webhooks"],"security":[{"Bearer":[]}]}},"\/public\/v3\/webhooks\/{id}\/delete":{"delete":{"summary":"Delete a webhook","parameters":[{"name":"id","in":"path","required":true,"description":"Webhook\u0027s ID","type":"string"}],"responses":{"200":{"description":"Returns status message"},"404":{"description":"Not found"}},"tags":["11. Webhooks"],"security":[{"Bearer":[]}]}},"\/oauth\/v2\/token":{"post":{"summary":"Returns OAuth 2.0 token","parameters":[{"name":"oauth_token_request","in":"body","description":"OAuth token request data","schema":{"$ref":"#\/definitions\/OAuthTokenRequestType"}}],"responses":{"200":{"description":"Returns OAuth 2.0 `Token` object","schema":{"$ref":"#\/definitions\/Token"}},"400":{"description":"Invalid input data"}},"tags":["01. Access Token"]}},"\/public\/v3\/webflow\/banks\/{bank_slug}\/redirect":{"post":{"parameters":[{"name":"bank_slug","in":"path","required":true,"description":"Bank slug","type":"string"},{"name":"url","in":"query","required":true,"description":"URL that friendlyScore will redirect to after Customer finish online banking flow.","type":"string"}],"responses":{"200":{"description":"Returns Bank Flow URL details","schema":{"items":{"$ref":"#\/definitions\/BankFlowUrl"},"type":"array"}},"404":{"description":"Not found"}},"tags":["12. Custom Web Flow"],"security":[{"AppUserToken":[]}]}}},"definitions":{"AffordabilityCollection":{"properties":{"data":{"title":"Array of affordability","items":{"$ref":"#\/definitions\/Affordability"},"type":"array","description":"Array of affordability"}},"type":"object"},"AffordabilityWeightCollection":{"properties":{"data":{"title":"Array of affordability weights","items":{"$ref":"#\/definitions\/AffordabilityWeight"},"type":"array","description":"Array of affordability weights"},"status":{"title":"Status","type":"string","description":"Status"}},"type":"object"},"AllowedRedirectUrl":{"properties":{"url":{"title":"URL","example":"http:\/\/example.com:8081\/friendlyscore-redirect-url","type":"string","description":"URL"},"comment":{"title":"Comment","example":"Default redirect for friendlyscore data processing","type":"string","description":"Comment"}},"type":"object"},"UserCollection":{"properties":{"data":{"title":"Array of users","items":{"$ref":"#\/definitions\/User"},"type":"array","description":"Array of users"}},"type":"object"},"User":{"required":["user_reference"],"properties":{"id":{"title":"Customer ID used across the API","example":"777","type":"string","description":"Customer ID used across the API"},"user_reference":{"title":"Unique user identifier from *your* database","example":"usr123215","type":"string","description":"Unique user identifier from *your* database"}},"type":"object"},"UserReferenceWithEntityType":{"required":["user_reference"],"properties":{"customer_ip":{"description":"Customer\u0027s IP address for analysis (if available)","example":"0.0.0.0","type":"string"},"user_reference":{"description":"Unique user identifier from *your* database","example":"asd123","type":"string"}},"type":"object"},"CashflowCollection":{"properties":{"data":{"title":"Array of cashflows","items":{"$ref":"#\/definitions\/Cashflow"},"type":"array","description":"Array of cashflows"}},"type":"object"},"ComponentInitResponse":{"properties":{"url":{"example":"https:\/\/component.friendlyscore.com\/render\/token=123456789","type":"string"},"created_at":{"example":1541014557,"type":"integer"},"expires_in":{"example":1800,"type":"integer"},"flow":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ComponentInitRequest":{"required":["ip","user_agent","origin"],"properties":{"ip":{"example":"1.2.3.4","type":"string"},"user_agent":{"example":"Mozilla\/5.0 (X11; Linux AMD64; rv:70.0.0) Gecko\/20100101 Firefox\/70.0.0","type":"string"},"user_reference":{"example":"my-user-1234","type":"string"},"origin":{"example":"https:\/\/example.com","type":"string"}},"type":"object"},"EventCollection":{"properties":{"data":{"title":"Array of events","items":{"$ref":"#\/definitions\/Event"},"type":"array","description":"Array of events"}},"type":"object"},"AccountInputCollection":{"required":["accounts"],"properties":{"accounts":{"title":"Array of accounts","items":{"$ref":"#\/definitions\/Account"},"type":"array","description":"Array of accounts"}},"type":"object"},"AccountCollection":{"properties":{"data":{"title":"Array of available accounts","items":{"$ref":"#\/definitions\/Account2"},"type":"array","description":"Array of available accounts"}},"type":"object"},"DtnDataProcessingSummary":{"properties":{"updated_at":{"title":"Date and time of last status change.","example":"1553077496","type":"string","format":"date-time","description":"Date and time of last status change."},"processing_status":{"title":"Processing status of the posted piece of data","example":"in_progress","type":"string","enum":["failed","in_progress","finished"],"description":"Processing status of the posted piece of data"},"dtn_slug":{"title":"Slug of the relevant data process or DTN","example":"__primary_mobile123__cv","type":"string","description":"Slug of the relevant data process or DTN"}},"type":"object"},"BalanceInputCollection":{"required":["balances"],"properties":{"balances":{"title":"Array of balances","items":{"$ref":"#\/definitions\/Balance"},"type":"array","description":"Array of balances"}},"type":"object"},"TransactionInputCollection":{"required":["transactions"],"properties":{"transactions":{"title":"Array of transactions","items":{"$ref":"#\/definitions\/Transaction"},"type":"array","description":"Array of transactions"}},"type":"object"},"BalanceCollection":{"properties":{"data":{"title":"Array of available balances","items":{"$ref":"#\/definitions\/Balance2"},"type":"array","description":"Array of available balances"}},"type":"object"},"BankWithConsentsCollection":{"properties":{"data":{"title":"Array of available banks","items":{"$ref":"#\/definitions\/BankWithConsents"},"type":"array","description":"Array of available banks"}},"type":"object"},"ConsentData":{"required":["consent_id","creation_date_time","status","status_update_date_time"],"properties":{"consent_id":{"title":"Unique identification as assigned to identify the account access consent resource.","type":"string","minLength":1,"description":"Unique identification as assigned to identify the account access consent resource."},"creation_date_time":{"title":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format."},"status":{"title":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked.","type":"string","description":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked."},"status_update_date_time":{"title":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format."},"expiration_date_time":{"title":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_from_date_time":{"title":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_to_date_time":{"title":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"consent_reconfirmation_date":{"title":"Last Consent reconfirmation date made by customer","example":"1553077496","type":"string","format":"date-time","description":"Last Consent reconfirmation date made by customer"}},"type":"object"},"ConsentReconfirmationData":{"properties":{"status":{"type":"boolean"}},"type":"object"},"PartyCollection":{"properties":{"data":{"title":"Array of available parties","items":{"$ref":"#\/definitions\/Party"},"type":"array","description":"Array of available parties"}},"type":"object"},"StatementCollection":{"properties":{"data":{"title":"Array of available statements","items":{"$ref":"#\/definitions\/Statement"},"type":"array","description":"Array of available statements"}},"type":"object"},"TransactionsCategoryPatch":{"required":["category_changes"],"properties":{"category_changes":{"title":"An array of transaction lists for different categories","items":{"$ref":"#\/definitions\/TransactionsCategoryPatchElement"},"type":"array","description":"An array of transaction lists for different categories"}},"type":"object"},"TransactionCollection":{"properties":{"data":{"title":"Array of available transactions","items":{"$ref":"#\/definitions\/Transaction2"},"type":"array","description":"Array of available transactions"}},"type":"object"},"BankCollection":{"properties":{"data":{"title":"Array of available banks","items":{"$ref":"#\/definitions\/Bank"},"type":"array","description":"Array of available banks"}},"type":"object"},"CategoryMetadata":{"properties":{"id":{"title":"Category id","example":"Bills","type":"string","description":"Category id"},"name":{"title":"Category name","example":"Bills","type":"string","description":"Category name"},"income_expenditure":{"title":"Info if this category applies to income or expenditure","example":"expenditure","type":"string","enum":["income","expenditure"],"description":"Info if this category applies to income or expenditure"}},"type":"object"},"Forecast":{"properties":{"financial_credibility_score":{"$ref":"#\/definitions\/FinancialCredibilityScore"},"affordability":{"$ref":"#\/definitions\/Score"},"liquidity":{"title":"Multiple liquidity scores for various timespans","items":{"$ref":"#\/definitions\/ScoreWithDays"},"type":"array","description":"Multiple liquidity scores for various timespans"},"financial_forecast":{"title":"Financial forecasts for available banks","items":{"$ref":"#\/definitions\/FinancialForecast"},"type":"array","description":"Financial forecasts for available banks"}},"type":"object"},"Insights":{"properties":{"income":{"$ref":"#\/definitions\/IncomeData"},"expenditure":{"$ref":"#\/definitions\/ExpenditureData"},"financial_patterns":{"$ref":"#\/definitions\/FinancialPatterns"},"financial_markers":{"$ref":"#\/definitions\/FinancialMarkersData"},"employment":{"$ref":"#\/definitions\/EmploymentData"}},"type":"object"},"BusinessInsights":{"properties":{"income":{"$ref":"#\/definitions\/IncomeData"},"expenditure":{"$ref":"#\/definitions\/ExpenditureData"},"financial_patterns":{"$ref":"#\/definitions\/FinancialPatterns"},"financial_markers":{"$ref":"#\/definitions\/BusinessFinancialMarkersData"},"employment":{"$ref":"#\/definitions\/BusinessEmploymentData"}},"type":"object"},"CustomerInvitation":{"required":["customer_type","email","reference"],"properties":{"id":{"example":"12345","type":"string"},"customer_type":{"example":"Individual","type":"string","enum":["Individual","Business"]},"last_name":{"example":"Doe","type":"string"},"first_name":{"example":"John","type":"string"},"company_name":{"example":"Example INC.","type":"string"},"email":{"example":"example@example.com","type":"string"},"phone":{"example":"+44123456789","type":"string"},"reference":{"example":"some-reference-id","type":"string"},"send_email":{"type":"boolean"},"created_at":{"example":"1553077496","type":"string","format":"date-time"},"revoked_at":{"example":"1553077496","type":"string","format":"date-time"},"used_at":{"example":"1553077496","type":"string","format":"date-time"},"expires_in":{"example":"3600","type":"integer"},"url":{"example":"https:\/\/friendlyscore.com\/invitation\/123456789abcdef","type":"string"}},"type":"object"},"CustomerInvitationType":{"required":["email","reference"],"properties":{"customer_type":{"description":"Customer type (enum: Individual, Business)","example":"Individual","type":"string","enum":["Individual","Business"]},"last_name":{"description":"Last name","example":"John","type":"string"},"first_name":{"description":"First name","example":"Doe","type":"string"},"company_name":{"description":"Company name","example":"Example INC.","type":"string"},"email":{"description":"Email","example":"john.doe@example.com","type":"string"},"phone":{"description":"Phone number","example":"+44123456789","type":"string"},"reference":{"description":"Reference","example":"123-123-123","type":"string"},"send_email":{"description":"Set if you want FriendlyScore to send email with invitation","type":"boolean"}},"type":"object"},"CustomerInvitationCollection":{"properties":{"page":{"type":"integer"},"pages":{"type":"integer"},"max_per_page":{"title":"Maximum item count per page","type":"integer","description":"Maximum item count per page"},"data":{"title":"Array of available customer invitations","items":{"$ref":"#\/definitions\/CustomerInvitation"},"type":"array","description":"Array of available customer invitations"},"_links":{"readOnly":true,"properties":{"self":{"properties":{"href":{"type":"string"}},"type":"object"},"next":{"properties":{"href":{"type":"string"}},"type":"object"},"previous":{"properties":{"href":{"type":"string"}},"type":"object"},"last":{"properties":{"href":{"type":"string"}},"type":"object"}}}},"type":"object"},"DtnDataProcessingSummaryCollection":{"properties":{"data":{"title":"Array of available DtnDataProcessingSummaries","items":{"$ref":"#\/definitions\/DtnDataProcessingSummary2"},"type":"array","description":"Array of available DtnDataProcessingSummaries"}},"type":"object"},"ReportReadinessStatus":{"properties":{"name":{"title":"Name of the referred report (current allowed values are: forecast|insights)","example":"insights","type":"string","description":"Name of the referred report (current allowed values are: forecast|insights)"},"status":{"title":"Readiness status for the given report","example":"not_ready","type":"string","enum":["no_data","not_ready","ready"],"description":"Readiness status for the given report"},"account_types":{"title":"List of available reports by bank account type (\u0022Business\u0022, \u0022Personal\u0022)","items":{"type":"string"},"type":"array","description":"List of available reports by bank account type (\u0022Business\u0022, \u0022Personal\u0022)"}},"type":"object"},"ReportReadinessStatusCollection":{"properties":{"data":{"title":"Array of available ReportReadinessStatuses","items":{"$ref":"#\/definitions\/ReportReadinessStatus2"},"type":"array","description":"Array of available ReportReadinessStatuses"}},"type":"object"},"UserBank":{"properties":{"bank":{"$ref":"#\/definitions\/Bank2"},"accounts":{"title":"User accounts related to the given bank","items":{"$ref":"#\/definitions\/Account3"},"type":"array","description":"User accounts related to the given bank"},"connected":{"title":"Information if the user has connected the given bank","type":"boolean","description":"Information if the user has connected the given bank"},"last_account_consent":{"$ref":"#\/definitions\/ConsentData3"}},"type":"object"},"ConsentScreen":{"properties":{"logo":{"title":"Screen logo","example":"http:\/\/example.com\/somelocation","type":"string","description":"Screen logo"},"children":{"title":"Screen contents","items":{"$ref":"#\/definitions\/ConsentScreenElement"},"type":"array","description":"Screen contents"}},"type":"object"},"ConsentData2":{"required":["consent_id","creation_date_time","status","status_update_date_time","permissions"],"properties":{"consent_id":{"title":"Unique identification as assigned to identify the account access consent resource.","type":"string","minLength":1,"description":"Unique identification as assigned to identify the account access consent resource."},"creation_date_time":{"title":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format."},"status":{"title":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked.","type":"string","description":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked."},"status_update_date_time":{"title":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format."},"permissions":{"title":"Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.","items":{"type":"string"},"type":"array","description":"Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP."},"expiration_date_time":{"title":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_from_date_time":{"title":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_to_date_time":{"title":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"consent_reconfirmation_date":{"title":"Last Consent reconfirmation date made by customer","example":"1553077496","type":"string","format":"date-time","description":"Last Consent reconfirmation date made by customer"}},"type":"object"},"Webhook":{"properties":{"url":{"title":"URL","example":"http:\/\/example.com:8081\/friendlyscore-webhook","type":"string","description":"URL"},"comment":{"title":"Comment","example":"Default webhook for friendlyscore data processing","type":"string","description":"Comment"}},"type":"object"},"OAuthTokenRequestType":{"required":["client_id","client_secret","grant_type"],"properties":{"client_id":{"description":"OAuth client_id","example":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","type":"string"},"client_secret":{"description":"OAuth client_secret","example":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","type":"string"},"grant_type":{"description":"OAuth grant_type (only `client_credentials` is currently supported)","example":"client_credentials","type":"string"}},"type":"object"},"Token":{"properties":{"access_token":{"title":"Access token value","example":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","type":"string","description":"Access token value"},"expires_in":{"title":"Token expiry time in seconds","example":"3600","type":"integer","description":"Token expiry time in seconds"},"token_type":{"title":"Token type","example":"Bearer","type":"string","description":"Token type"},"scope":{"title":"Optional scope","type":"string","description":"Optional scope"}},"type":"object"},"BankFlowUrl":{"properties":{"url":{"title":"Bank flow URL","type":"string","description":"Bank flow URL"},"consent_id":{"title":"Bank consent ID","type":"string","description":"Bank consent ID"},"state":{"title":"Unique state for current process","type":"string","description":"Unique state for current process"},"transaction_from_date_time":{"title":"Since when transactions will be pulled","type":"integer","description":"Since when transactions will be pulled"},"transaction_to_date_time":{"title":"For how long data will be pulled","type":"integer","description":"For how long data will be pulled"}},"type":"object"},"Affordability":{"required":["year","month","amount","currency","affordability_type","account_type"],"properties":{"year":{"title":"Year","example":"2021","type":"integer","description":"Year"},"month":{"title":"Month","example":"2021","type":"integer","description":"Month"},"amount":{"title":"Affordability amount","example":"12.12","type":"number","format":"float","description":"Affordability amount"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"affordability_type":{"title":"Affordability Type","example":"default","type":"string","description":"Affordability Type"},"account_type":{"title":"Account Type","example":"Personal","type":"string","description":"Account Type"}},"type":"object"},"AffordabilityWeight":{"required":["id","value","category","income_expenditure"],"properties":{"id":{"title":"Year","example":"123","type":"integer","description":"Year"},"value":{"title":"Affordability amount","example":"10","type":"integer","description":"Affordability amount"},"category":{"title":"Category name","example":"Salary","type":"string","description":"Category name"},"income_expenditure":{"title":"Income or Expenditure","example":"income","type":"string","description":"Income or Expenditure"}},"type":"object"},"Cashflow":{"required":["type","predicted","average","data"],"properties":{"type":{"title":"Type","example":"FIXED_COSTS","type":"string","description":"Type"},"predicted":{"title":"Predicted value for the current month","example":"100.00","type":"number","format":"float","description":"Predicted value for the current month"},"average":{"title":"Average value for the whole period of the Data","example":"100.00","type":"number","format":"float","description":"Average value for the whole period of the Data"},"data":{"title":"Average value for the whole period of the Data","example":"[{ \u0027amount\u0027 : 100.99, \u0027date\u0027 : 123 }]","items":{"$ref":"#\/definitions\/HistoricalAmountWithCurrency"},"type":"array","description":"Average value for the whole period of the Data"}},"type":"object"},"Event":{"required":["id","event_type","account_type","year","month","day","threshold","description","amount","account_id","transaction_id","granularity","percentage_change","currency","higher_than_threshold","is_alert","is_event","created_at"],"properties":{"id":{"title":"Event Id","example":"1","type":"integer","description":"Event Id"},"event_type":{"title":"Event Type","example":"default","type":"string","description":"Event Type"},"account_type":{"title":"Account Type","example":"default","type":"string","description":"Account Type"},"year":{"title":"Year","example":"2021","type":"integer","description":"Year"},"month":{"title":"Month","example":"2021","type":"integer","description":"Month"},"day":{"title":"Day","example":"1","type":"integer","description":"Day"},"threshold":{"title":"Threshold","example":"1","type":"integer","description":"Threshold"},"description":{"title":"Description","example":"default","type":"string","description":"Description"},"amount":{"title":"Amount","example":"100.99","type":"number","format":"float","description":"Amount"},"account_id":{"title":"Account Id","example":"123","type":"integer","description":"Account Id"},"transaction_id":{"title":"Transaction Id","example":"123","type":"integer","description":"Transaction Id"},"granularity":{"title":"Granularity","example":"TRANSACTIONAL","type":"string","description":"Granularity"},"percentage_change":{"title":"Percentage Change","example":"default","type":"number","format":"float","description":"Percentage Change"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"higher_than_threshold":{"title":"Higher Than Threshold","example":"true","type":"boolean","description":"Higher Than Threshold"},"is_alert":{"title":"Is Alert Flag","example":"true","type":"boolean","description":"Is Alert Flag"},"is_event":{"title":"Is Event Flag","example":"true","type":"boolean","description":"Is Event Flag"},"created_at":{"title":"Created at timestamp","example":"1553077496","type":"integer","description":"Created at timestamp"}},"type":"object"},"Account":{"required":["id","currency","bank_slug","type","sub_type","number","sort_code_and_account_number"],"properties":{"id":{"title":"Id","example":"123","type":"integer","description":"Id"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"name":{"title":"The account name is the name or names of the account owner(s) represented at an account level,\nas displayed by the ASPSP\u0027s online channels. Note, the account name is not the product name or the nickname of the account.","example":"Mr Kevin","type":"string","description":"The account name is the name or names of the account owner(s) represented at an account level,\nas displayed by the ASPSP\u0027s online channels. Note, the account name is not the product name or the nickname of the account."},"nickname":{"title":"The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.","example":"Main account","type":"string","description":"The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account."},"identification":{"title":"Identification assigned by an institution to identify an account. This identification is known by the account owner.","example":"80200110203345","type":"string","description":"Identification assigned by an institution to identify an account. This identification is known by the account owner."},"secondary_identification":{"title":"This is secondary identification of the account, as assigned by the account servicing institution.","description":"This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).","example":"00021","type":"string"},"bank_slug":{"title":"Slug of the associated bank","example":"barclays","type":"string","description":"Slug of the associated bank"},"type":{"title":"Account type","example":"Personal","type":"string","enum":["Business","Personal"],"description":"Account type"},"sub_type":{"title":"Account sub type","example":"Savings","type":"string","enum":["ChargeCard","CreditCard","CurrentAccount","EMoney","Loan","Mortgage","PrePaidCard","Savings"],"description":"Account sub type"},"number":{"title":"Account number","example":"12123412341234123412341234","type":"string","description":"Account number"},"sort_code_and_account_number":{"title":"Account sort code and number","example":"[\u0027sort_code\u0027 =\u003E 123456, \u0027account_number\u0027 =\u003E 12345678]","additionalProperties":true,"type":"object","description":"Account sort code and number"},"scheme_name":{"title":"Name of the identification scheme, in a coded form as published in an external list.","example":"UK.OBIE.SortCodeAccountNumber","type":"string","description":"Name of the identification scheme, in a coded form as published in an external list."},"is_authorized":{"title":"Is FriendlyScore authorized to pull data for this bank account. If false, you need to ask your Customer to re-authorize FriendlyScore","example":"true","type":"boolean","description":"Is FriendlyScore authorized to pull data for this bank account. If false, you need to ask your Customer to re-authorize FriendlyScore"}},"type":"object"},"Account2":{"required":["id","currency","bank_slug","type","sub_type","number","sort_code_and_account_number"],"properties":{"id":{"title":"Id","example":"123","type":"integer","description":"Id"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"name":{"title":"The account name is the name or names of the account owner(s) represented at an account level,\nas displayed by the ASPSP\u0027s online channels. Note, the account name is not the product name or the nickname of the account.","example":"Mr Kevin","type":"string","description":"The account name is the name or names of the account owner(s) represented at an account level,\nas displayed by the ASPSP\u0027s online channels. Note, the account name is not the product name or the nickname of the account."},"nickname":{"title":"The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.","example":"Main account","type":"string","description":"The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account."},"identification":{"title":"Identification assigned by an institution to identify an account. This identification is known by the account owner.","example":"80200110203345","type":"string","description":"Identification assigned by an institution to identify an account. This identification is known by the account owner."},"secondary_identification":{"title":"This is secondary identification of the account, as assigned by the account servicing institution.","description":"This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).","example":"00021","type":"string"},"bank_slug":{"title":"Slug of the associated bank","example":"barclays","type":"string","description":"Slug of the associated bank"},"type":{"title":"Account type","example":"Personal","type":"string","enum":["Business","Personal"],"description":"Account type"},"sub_type":{"title":"Account sub type","example":"Savings","type":"string","enum":["ChargeCard","CreditCard","CurrentAccount","EMoney","Loan","Mortgage","PrePaidCard","Savings"],"description":"Account sub type"},"number":{"title":"Account number","example":"12123412341234123412341234","type":"string","description":"Account number"},"sort_code_and_account_number":{"title":"Account sort code and number","example":"[\u0027sort_code\u0027 =\u003E 123456, \u0027account_number\u0027 =\u003E 12345678]","additionalProperties":true,"type":"object","description":"Account sort code and number"},"scheme_name":{"title":"Name of the identification scheme, in a coded form as published in an external list.","example":"UK.OBIE.SortCodeAccountNumber","type":"string","description":"Name of the identification scheme, in a coded form as published in an external list."},"is_authorized":{"title":"Is FriendlyScore authorized to pull data for this bank account. If false, you need to ask your Customer to re-authorize FriendlyScore","example":"true","type":"boolean","description":"Is FriendlyScore authorized to pull data for this bank account. If false, you need to ask your Customer to re-authorize FriendlyScore"}},"type":"object"},"Balance":{"required":["amount","currency","type","bank_slug","account_number","date_time"],"properties":{"amount":{"title":"Amount of associated currency (positive for income and negative for expenditure)","example":"22.35","type":"number","format":"float","description":"Amount of associated currency (positive for income and negative for expenditure)"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"type":{"title":"Balance type (compatible with OpenBanking 3.1 specification)","example":"ClosingBooked","type":"string","enum":["ClosingAvailable","ClosingBooked","ClosingCleared","Expected","ForwardAvailable","Information","InterimAvailable","InterimBooked","InterimCleared","OpeningAvailable","OpeningBooked","OpeningCleared","PreviouslyClosedBooked","FriendlyScoreExpected"],"description":"Balance type (compatible with OpenBanking 3.1 specification)"},"custom_data":{"title":"Optional additional raw data (custom object).","example":{"some_field":"some_value"},"additionalProperties":true,"type":"object","description":"Optional additional raw data (custom object)."},"id":{"title":"Id.","type":"string","description":"Id."},"bank_slug":{"title":"Slug of the associated bank","example":"barclays","type":"string","description":"Slug of the associated bank"},"account_number":{"title":"Number of the associated account","example":"12123412341234123412341234","type":"string","description":"Number of the associated account"},"date_time":{"title":"Date\\Time","example":"1553077496","type":"string","format":"date-time","description":"Date\\Time"},"credit_line":{"title":"Credit line","example":"[{\u0027type\u0027 =\u003E \u0027Pre-Aproved\u0027, \u0027amount\u0027 =\u003E \u00274500.00\u0027}]","items":{"$ref":"#\/definitions\/CreditLine"},"type":"array","description":"Credit line"}},"type":"object"},"Transaction":{"required":["external_transaction_id","name","amount","currency","status","bank_slug","account_number","booking_date_time"],"properties":{"external_transaction_id":{"title":"Transaction ID from the original data source. Must be unique for associated user and account.","example":"123","type":"string","description":"Transaction ID from the original data source. Must be unique for associated user and account."},"name":{"title":"Transaction name or description","example":"Granny\u0027s Bakery","type":"string","description":"Transaction name or description"},"type":{"title":"Transaction type, if available","example":"optional_type_description","type":"string","description":"Transaction type, if available"},"amount":{"title":"Amount of associated currency (positive for income and negative for expenditure)","example":"22.35","type":"number","format":"float","description":"Amount of associated currency (positive for income and negative for expenditure)"},"balance":{"$ref":"#\/definitions\/BaseBalance"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"status":{"title":"Transaction status (compatible with OpenBanking 3.1 specification)","example":"Booked","type":"string","enum":["Booked","Pending","Rejected"],"description":"Transaction status (compatible with OpenBanking 3.1 specification)"},"bank_slug":{"title":"Slug of the associated bank","example":"barclays","type":"string","description":"Slug of the associated bank"},"account_number":{"title":"Number of the associated account","example":"12123412341234123412341234","type":"string","description":"Number of the associated account"},"category":{"title":"Category of the transaction","example":"Groceries \u0026 Supplies","type":"string","description":"Category of the transaction"},"address_line":{"title":"Address line","example":"1234 Some Address, London","type":"string","description":"Address line"},"value_date_time":{"title":"Value date\/time","example":"1553077496","type":"string","format":"date-time","description":"Value date\/time"},"booking_date_time":{"title":"Booking date\/time","example":"1553077496","type":"string","format":"date-time","description":"Booking date\/time"},"custom_data":{"title":"Optional additional raw data (custom object).","example":{"some_field":"some_value"},"additionalProperties":true,"type":"object","description":"Optional additional raw data (custom object)."},"merchant_details":{"title":"Merchant Details","example":"[\u0027merchant_name\u0027 =\u003E \u0027abc\u0027, \u0027merchant_category_code\u0027 =\u003E \u0027123\u0027]","additionalProperties":true,"type":"object","description":"Merchant Details"},"proprietary_bank_transaction_code":{"title":"Proprietary Bank Transaction Code","example":"[\u0027issuer\u0027 =\u003E \u0027abc\u0027, \u0027code\u0027 =\u003E \u0027123\u0027]","additionalProperties":true,"type":"object","description":"Proprietary Bank Transaction Code"}},"type":"object"},"Balance2":{"required":["amount","currency","type","bank_slug","account_number","date_time"],"properties":{"amount":{"title":"Amount of associated currency (positive for income and negative for expenditure)","example":"22.35","type":"number","format":"float","description":"Amount of associated currency (positive for income and negative for expenditure)"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"type":{"title":"Balance type (compatible with OpenBanking 3.1 specification)","example":"ClosingBooked","type":"string","enum":["ClosingAvailable","ClosingBooked","ClosingCleared","Expected","ForwardAvailable","Information","InterimAvailable","InterimBooked","InterimCleared","OpeningAvailable","OpeningBooked","OpeningCleared","PreviouslyClosedBooked","FriendlyScoreExpected"],"description":"Balance type (compatible with OpenBanking 3.1 specification)"},"custom_data":{"title":"Optional additional raw data (custom object).","example":{"some_field":"some_value"},"additionalProperties":true,"type":"object","description":"Optional additional raw data (custom object)."},"id":{"title":"Id.","type":"string","description":"Id."},"bank_slug":{"title":"Slug of the associated bank","example":"barclays","type":"string","description":"Slug of the associated bank"},"account_number":{"title":"Number of the associated account","example":"12123412341234123412341234","type":"string","description":"Number of the associated account"},"date_time":{"title":"Date\\Time","example":"1553077496","type":"string","format":"date-time","description":"Date\\Time"},"credit_line":{"title":"Credit line","example":"[{\u0027type\u0027 =\u003E \u0027Pre-Aproved\u0027, \u0027amount\u0027 =\u003E \u00274500.00\u0027}]","items":{"$ref":"#\/definitions\/CreditLine2"},"type":"array","description":"Credit line"}},"type":"object"},"BankWithConsents":{"properties":{"name":{"title":"Bank name.","example":"PKO","type":"string","description":"Bank name."},"slug":{"title":"Bank slug (unique identifier)","example":"pko","type":"string","description":"Bank slug (unique identifier)"},"is_active":{"title":"Denotes if this bank can currently be used.","type":"boolean","description":"Denotes if this bank can currently be used."},"country_code":{"title":"ISO ALPHA2 code of the assigned country","example":"GB","type":"string","description":"ISO ALPHA2 code of the assigned country"},"type":{"title":"Bank type (Personal or Business)","example":"Personal","type":"string","description":"Bank type (Personal or Business)"},"is_working":{"title":"Denotes if this bank\u0027s API is responding at the moment.","type":"boolean","description":"Denotes if this bank\u0027s API is responding at the moment."},"is_api_only":{"title":"Denotes if this bank is available only via the API (no Connect availability)","type":"boolean","description":"Denotes if this bank is available only via the API (no Connect availability)"},"account_consents":{"items":{"$ref":"#\/definitions\/ConsentData4"},"type":"array"}},"type":"object"},"Party":{"properties":{"AccountId":{"title":"Account ID","example":"123","type":"string","description":"Account ID"},"PartyId":{"title":"Party ID","example":"759553629","type":"string","description":"Party ID"},"Name":{"title":"Name","example":"Elon Musk","type":"string","description":"Name"},"FullLegalName":{"title":"Full Legal Name","example":"Elon G Musk","type":"string","description":"Full Legal Name"},"LegalStructure":{"title":"Legal Structure","example":"UK.OBIE.Individual","type":"string","description":"Legal Structure"},"PartyType":{"title":"Party Type","example":"Sole","type":"string","description":"Party Type"},"PartyNumber":{"title":"Party Number","example":"123456","type":"string","description":"Party Number"},"EmailAddress":{"title":"E-mail Address","example":"john@friendlyscore.com","type":"string","description":"E-mail Address"},"Phone":{"title":"Phone","example":"+447000000000","type":"string","description":"Phone"},"Mobile":{"title":"Mobile","example":"+447000000000","type":"string","description":"Mobile"},"BeneficialOwnership":{"title":"Beneficial Ownership","example":"true","type":"boolean","description":"Beneficial Ownership"},"AccountRole":{"title":"Account Role","example":"123456","type":"string","description":"Account Role"},"Relationships":{"$ref":"#\/definitions\/PartyRelationships"},"Address":{"title":"Address","items":{"$ref":"#\/definitions\/PartyAddress"},"type":"array","description":"Address"}},"type":"object"},"Statement":{"properties":{"AccountId":{"title":"Account ID","example":"123","type":"string","description":"Account ID"},"StatementId":{"title":"Statement ID","example":"123","type":"string","description":"Statement ID"},"StatementReference":{"title":"Statement Reference","example":"123","type":"string","description":"Statement Reference"},"Type":{"title":"Type","example":"123","type":"string","description":"Type"},"StartDateTime":{"title":"Start Date Time","example":"123","type":"string","description":"Start Date Time"},"EndDateTime":{"title":"End Date Time","example":"123","type":"string","description":"End Date Time"},"CreationDateTime":{"title":"Creation Date Time","example":"123","type":"string","description":"Creation Date Time"},"StatementDescription":{"title":"Statement Descriptions","example":"[\u0027description 1\u0027, \u0027description 2\u0027]","items":{"type":"string"},"type":"array","description":"Statement Descriptions"},"StatementFee":{"title":"Statement Fees","items":{"$ref":"#\/definitions\/StatementFee"},"type":"array","description":"Statement Fees"},"StatementInterest":{"title":"Statement Interests","items":{"$ref":"#\/definitions\/StatementInterest"},"type":"array","description":"Statement Interests"},"StatementRate":{"title":"Statement Rates","items":{"$ref":"#\/definitions\/StatementRate"},"type":"array","description":"Statement Rates"},"StatementValue":{"title":"Statement Values","items":{"$ref":"#\/definitions\/StatementValue"},"type":"array","description":"Statement Values"},"StatementDateTimes":{"title":"Statement Date Times","items":{"$ref":"#\/definitions\/StatementDateTime"},"type":"array","description":"Statement Date Times"},"StatementAmounts":{"title":"Statement Amounts","items":{"$ref":"#\/definitions\/StatementAmount"},"type":"array","description":"Statement Amounts"},"StatementBenefits":{"title":"Statement Benefits","items":{"$ref":"#\/definitions\/StatementBenefit"},"type":"array","description":"Statement Benefits"}},"type":"object"},"TransactionsCategoryPatchElement":{"required":["category_id","transaction_ids"],"properties":{"category_id":{"type":"string"},"transaction_ids":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Transaction2":{"required":["external_transaction_id","name","amount","currency","status","bank_slug","account_number","booking_date_time"],"properties":{"id":{"title":"Transaction ID","example":"123","type":"string","description":"Transaction ID"},"external_transaction_id":{"title":"Transaction ID from the original data source. Must be unique for associated user and account.","example":"123","type":"string","description":"Transaction ID from the original data source. Must be unique for associated user and account."},"name":{"title":"Transaction name or description","example":"Granny\u0027s Bakery","type":"string","description":"Transaction name or description"},"type":{"title":"Transaction type, if available","example":"optional_type_description","type":"string","description":"Transaction type, if available"},"amount":{"title":"Amount of associated currency (positive for income and negative for expenditure)","example":"22.35","type":"number","format":"float","description":"Amount of associated currency (positive for income and negative for expenditure)"},"balance":{"$ref":"#\/definitions\/BaseBalance2"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"status":{"title":"Transaction status (compatible with OpenBanking 3.1 specification)","example":"Booked","type":"string","enum":["Booked","Pending","Rejected"],"description":"Transaction status (compatible with OpenBanking 3.1 specification)"},"bank_slug":{"title":"Slug of the associated bank","example":"barclays","type":"string","description":"Slug of the associated bank"},"account_number":{"title":"Number of the associated account","example":"12123412341234123412341234","type":"string","description":"Number of the associated account"},"category":{"title":"Category of the transaction","example":"Groceries \u0026 Supplies","type":"string","description":"Category of the transaction"},"category_type":{"title":"Category type","example":"fixed","type":"string","description":"Category type"},"address_line":{"title":"Address line","example":"1234 Some Address, London","type":"string","description":"Address line"},"value_date_time":{"title":"Value date\/time","example":"1553077496","type":"string","format":"date-time","description":"Value date\/time"},"booking_date_time":{"title":"Booking date\/time","example":"1553077496","type":"string","format":"date-time","description":"Booking date\/time"},"custom_data":{"title":"Optional additional raw data (custom object).","example":{"some_field":"some_value"},"additionalProperties":true,"type":"object","description":"Optional additional raw data (custom object)."},"merchant_details":{"title":"Merchant Details","example":"[\u0027merchant_name\u0027 =\u003E \u0027abc\u0027, \u0027merchant_category_code\u0027 =\u003E \u0027123\u0027]","additionalProperties":true,"type":"object","description":"Merchant Details"},"proprietary_bank_transaction_code":{"title":"Proprietary Bank Transaction Code","example":"[\u0027issuer\u0027 =\u003E \u0027abc\u0027, \u0027code\u0027 =\u003E \u0027123\u0027]","additionalProperties":true,"type":"object","description":"Proprietary Bank Transaction Code"}},"type":"object"},"Bank":{"properties":{"name":{"title":"Bank name.","example":"PKO","type":"string","description":"Bank name."},"slug":{"title":"Bank slug (unique identifier)","example":"pko","type":"string","description":"Bank slug (unique identifier)"},"is_active":{"title":"Denotes if this bank can currently be used.","type":"boolean","description":"Denotes if this bank can currently be used."},"country_code":{"title":"ISO ALPHA2 code of the assigned country","example":"GB","type":"string","description":"ISO ALPHA2 code of the assigned country"},"type":{"title":"Bank type (Personal or Business)","example":"Personal","type":"string","description":"Bank type (Personal or Business)"},"is_working":{"title":"Denotes if this bank\u0027s API is responding at the moment.","type":"boolean","description":"Denotes if this bank\u0027s API is responding at the moment."},"is_api_only":{"title":"Denotes if this bank is available only via the API (no Connect availability)","type":"boolean","description":"Denotes if this bank is available only via the API (no Connect availability)"}},"type":"object"},"FinancialCredibilityScore":{"properties":{"generic":{"$ref":"#\/definitions\/ScoreWithCodes"},"custom":{"$ref":"#\/definitions\/ScoreWithCodes"}},"type":"object"},"Score":{"properties":{"score":{"title":"Score","example":"700","type":"integer","description":"Score"},"band":{"title":"Band","example":"b","type":"string","description":"Band"}},"type":"object"},"ScoreWithDays":{"properties":{"score":{"title":"Score","example":"700","type":"integer","description":"Score"},"band":{"title":"Band","example":"b","type":"string","description":"Band"},"days":{"title":"Timespan in days","type":"integer","description":"Timespan in days"}},"type":"object"},"FinancialForecast":{"properties":{"bank":{"$ref":"#\/definitions\/FinancialForecastBank"}},"type":"object"},"IncomeData":{"properties":{"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"monthly_amounts":{"title":"Array of amounts","items":{"$ref":"#\/definitions\/HistoricalAmount"},"type":"array","description":"Array of amounts"},"categories":{"title":"Collection of fixed income data","items":{"$ref":"#\/definitions\/IncomeCategoryData"},"type":"array","description":"Collection of fixed income data"}},"type":"object"},"ExpenditureData":{"properties":{"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"monthly_amounts":{"title":"Array of amounts","items":{"$ref":"#\/definitions\/HistoricalAmount"},"type":"array","description":"Array of amounts"},"categories":{"title":"Collection of fixed expenditure data","items":{"$ref":"#\/definitions\/ExpenditureCategoryData"},"type":"array","description":"Collection of fixed expenditure data"}},"type":"object"},"FinancialPatterns":{"properties":{"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"recurrence":{"title":"Recurrent transactions data","items":{"$ref":"#\/definitions\/Recurrence"},"type":"array","description":"Recurrent transactions data"},"by_category":{"title":"Pattern data on different categories","items":{"$ref":"#\/definitions\/CategoryPattern"},"type":"array","description":"Pattern data on different categories"}},"type":"object"},"FinancialMarkersData":{"properties":{"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"new_debt_indicator":{"title":"New debt indicator - Determines receipt of new loan income in the most recent 3 months","type":"boolean","description":"New debt indicator - Determines receipt of new loan income in the most recent 3 months"},"debt_management_indicator":{"title":"New demanagement indicator - Determines debt management\/collection activity is detected in the most recent 12 months","type":"boolean","description":"New demanagement indicator - Determines debt management\/collection activity is detected in the most recent 12 months"},"recent_account_indicator":{"title":"Recent Account Indicator - Determines the oldest transaction is less than 3 months","type":"boolean","description":"Recent Account Indicator - Determines the oldest transaction is less than 3 months"},"mortgage_rent_indicator":{"title":"Mortgage or Rent Indicator - Determines mortgage\/rent payments are detected in the most recent 12 months","type":"boolean","description":"Mortgage or Rent Indicator - Determines mortgage\/rent payments are detected in the most recent 12 months"},"insurance_indicator":{"title":"Insurance Indicator - Determines insurance payments are detected in the most recent 12 months","type":"boolean","description":"Insurance Indicator - Determines insurance payments are detected in the most recent 12 months"},"bank_charges":{"$ref":"#\/definitions\/HistoricalCummulativeStat"},"returned_direct_debits":{"$ref":"#\/definitions\/HistoricalCummulativeStat"},"credit_repayments":{"$ref":"#\/definitions\/AmountStat"},"negative_balance_ratio":{"title":"Negative balance ratio","type":"number","format":"float","description":"Negative balance ratio"},"debit_bank_transfer":{"$ref":"#\/definitions\/AmountStat"},"summary_averages":{"$ref":"#\/definitions\/FinancialMarkersDataSummaryAverages"},"council_tax_indicator":{"title":"Council Tax indicator - Determines council tax payments are detected in the most recent 12 months","type":"boolean","description":"Council Tax indicator - Determines council tax payments are detected in the most recent 12 months"},"savings_investment_indicator":{"title":"Savings Investment Indicator - Determines savings\/investments payments are detected in the most recent 12 months","type":"boolean","description":"Savings Investment Indicator - Determines savings\/investments payments are detected in the most recent 12 months"},"direct_loan_indicator":{"title":"Direct Loan Indicator - Determines receipt of new payday loan income in the most recent 6 months","type":"boolean","description":"Direct Loan Indicator - Determines receipt of new payday loan income in the most recent 6 months"},"bnpl_indicator":{"title":"Buy Not Pay Later Indicator -Determines Buy Now Pay Later payments are detected in the most recent 3 months","type":"boolean","description":"Buy Not Pay Later Indicator -Determines Buy Now Pay Later payments are detected in the most recent 3 months"},"utility_payments":{"$ref":"#\/definitions\/HistoricalCummulativeStat"},"gambling":{"$ref":"#\/definitions\/AmountStat"},"gambling_payout":{"$ref":"#\/definitions\/AmountStat"},"cash_withdrawals":{"$ref":"#\/definitions\/AmountStat"},"loan_income":{"$ref":"#\/definitions\/AmountStat"},"payday_loan":{"$ref":"#\/definitions\/AmountStat"}},"type":"object"},"EmploymentData":{"properties":{"number_of_salaries":{"title":"Number of salaries","example":"2","type":"integer","description":"Number of salaries"},"expected_salary":{"title":"Array of expected salaries","items":{"$ref":"#\/definitions\/SalaryExpectation"},"type":"array","description":"Array of expected salaries"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"new_employer_indicator":{"title":"New employer indicator - Determines the presence of a new salary group in most recent 3 months","type":"boolean","description":"New employer indicator - Determines the presence of a new salary group in most recent 3 months"},"possible_loss_of_income_indicator":{"title":"Possible loss of income indicator - Determines that the average salary of recent 3 months is less than 20% of 12 months average","type":"boolean","description":"Possible loss of income indicator - Determines that the average salary of recent 3 months is less than 20% of 12 months average"},"out_of_work_benefit_indicator":{"title":"Out of work benefit indicator - Determines the presence of out of work benefit payments in most recent 3 months","type":"boolean","description":"Out of work benefit indicator - Determines the presence of out of work benefit payments in most recent 3 months"},"child_benefits_indicator":{"title":"Child Benefits Indicator - Determines child benefit payments are detected in the most recent 3 months","type":"boolean","description":"Child Benefits Indicator - Determines child benefit payments are detected in the most recent 3 months"}},"type":"object"},"BusinessFinancialMarkersData":{"properties":{"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"new_debt_indicator":{"title":"New debt indicator - Determines receipt of new loan income in the most recent 3 months","type":"boolean","description":"New debt indicator - Determines receipt of new loan income in the most recent 3 months"},"debt_management_indicator":{"title":"New demanagement indicator - Determines debt management\/collection activity is detected in the most recent 12 months","type":"boolean","description":"New demanagement indicator - Determines debt management\/collection activity is detected in the most recent 12 months"},"recent_account_indicator":{"title":"Recent account indicator","type":"boolean","description":"Recent account indicator"},"mortgage_rent_indicator":{"title":"Mortgage or Rent Indicator - Determines mortgage\/rent payments are detected in the most recent 12 months","type":"boolean","description":"Mortgage or Rent Indicator - Determines mortgage\/rent payments are detected in the most recent 12 months"},"insurance_indicator":{"title":"Insurance Indicator - Determines insurance payments are detected in the most recent 12 months","type":"boolean","description":"Insurance Indicator - Determines insurance payments are detected in the most recent 12 months"},"bank_charges":{"$ref":"#\/definitions\/HistoricalCummulativeStat"},"returned_direct_debits":{"$ref":"#\/definitions\/HistoricalCummulativeStat"},"credit_repayments":{"$ref":"#\/definitions\/AmountStat"},"negative_balance_ratio":{"title":"Negative balance ratio","type":"number","format":"float","description":"Negative balance ratio"},"debit_bank_transfer":{"$ref":"#\/definitions\/AmountStat"},"summary_averages":{"$ref":"#\/definitions\/FinancialMarkersDataSummaryAverages"},"expense_proportion":{"$ref":"#\/definitions\/ExpenseProportion"},"high_cost_short_term_credit_indicator":{"title":"High cost short term credit indicator","type":"boolean","description":"High cost short term credit indicator"},"profitability_ratio":{"title":"Profitability ratio","type":"number","format":"float","description":"Profitability ratio"},"income_proportion":{"$ref":"#\/definitions\/IncomeProportion"}},"type":"object"},"BusinessEmploymentData":{"properties":{"number_of_salaries":{"title":"Number of salaries","example":"2","type":"integer","description":"Number of salaries"},"expected_salary":{"title":"Array of expected salaries","items":{"$ref":"#\/definitions\/SalaryExpectation"},"type":"array","description":"Array of expected salaries"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"}},"type":"object"},"DtnDataProcessingSummary2":{"properties":{"updated_at":{"title":"Date and time of last status change.","example":"1553077496","type":"string","format":"date-time","description":"Date and time of last status change."},"processing_status":{"title":"Processing status of the posted piece of data","example":"in_progress","type":"string","enum":["failed","in_progress","finished"],"description":"Processing status of the posted piece of data"},"dtn_slug":{"title":"Slug of the relevant data process or DTN","example":"__primary_mobile123__cv","type":"string","description":"Slug of the relevant data process or DTN"}},"type":"object"},"ReportReadinessStatus2":{"properties":{"name":{"title":"Name of the referred report (current allowed values are: forecast|insights)","example":"insights","type":"string","description":"Name of the referred report (current allowed values are: forecast|insights)"},"status":{"title":"Readiness status for the given report","example":"not_ready","type":"string","enum":["no_data","not_ready","ready"],"description":"Readiness status for the given report"},"account_types":{"title":"List of available reports by bank account type (\u0022Business\u0022, \u0022Personal\u0022)","items":{"type":"string"},"type":"array","description":"List of available reports by bank account type (\u0022Business\u0022, \u0022Personal\u0022)"}},"type":"object"},"Bank2":{"properties":{"name":{"title":"Bank name.","example":"PKO","type":"string","description":"Bank name."},"logo_url":{"example":"http:\/\/bank-of-mordor.com\/nice-logo.jpg","type":"string"},"bank_configuration":{"$ref":"#\/definitions\/BankConfiguration"},"slug":{"title":"Bank slug (unique identifier)","example":"pko","type":"string","description":"Bank slug (unique identifier)"},"is_active":{"title":"Denotes if this bank can currently be used.","type":"boolean","description":"Denotes if this bank can currently be used."},"country_code":{"title":"ISO ALPHA2 code of the assigned country","example":"GB","type":"string","description":"ISO ALPHA2 code of the assigned country"},"type":{"title":"Bank type (Personal or Business)","example":"Personal","type":"string","description":"Bank type (Personal or Business)"},"is_working":{"title":"Denotes if this bank\u0027s API is responding at the moment.","type":"boolean","description":"Denotes if this bank\u0027s API is responding at the moment."},"is_api_only":{"title":"Denotes if this bank is available only via the API (no Connect availability)","type":"boolean","description":"Denotes if this bank is available only via the API (no Connect availability)"}},"type":"object"},"Account3":{"properties":{"account_type":{"example":"Personal","type":"string","enum":["Personal","Business","External"]},"account_number":{"title":"accountNumber.","example":"************5564","type":"string","description":"accountNumber."},"is_authorized":{"type":"boolean"}},"type":"object"},"ConsentData3":{"required":["consent_id","creation_date_time","status","status_update_date_time","permissions"],"properties":{"consent_id":{"title":"Unique identification as assigned to identify the account access consent resource.","type":"string","minLength":1,"description":"Unique identification as assigned to identify the account access consent resource."},"creation_date_time":{"title":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format."},"status":{"title":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked.","type":"string","description":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked."},"status_update_date_time":{"title":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format."},"permissions":{"title":"Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.","items":{"type":"string"},"type":"array","description":"Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP."},"expiration_date_time":{"title":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_from_date_time":{"title":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_to_date_time":{"title":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"consent_reconfirmation_date":{"title":"Last Consent reconfirmation date made by customer","example":"1553077496","type":"string","format":"date-time","description":"Last Consent reconfirmation date made by customer"}},"type":"object"},"ConsentScreenElement":{"properties":{"type":{"title":"Element type","example":"h1","type":"string","description":"Element type"},"text":{"title":"Element text","example":"Some text","type":"string","description":"Element text"},"children":{"title":"Element\u0027s children","items":{"$ref":"#\/definitions\/ConsentScreenElement"},"type":"array","description":"Element\u0027s children"}},"type":"object"},"HistoricalAmountWithCurrency":{"properties":{"amount":{"title":"Amount of associated currency","example":"22.35","type":"number","format":"float","description":"Amount of associated currency"},"year":{"title":"Year","example":"2019","type":"integer","description":"Year"},"month":{"title":"Month","example":"11","type":"integer","description":"Month"},"currency":{"title":"Currency","example":"GBP","type":"string","description":"Currency"}},"type":"object"},"CreditLine":{"required":["amount","included","type"],"properties":{"amount":{"title":"Amount","example":"100.54","type":"number","format":"float","description":"Amount"},"included":{"title":"Included","example":"false","type":"boolean","description":"Included"},"type":{"title":"Type","example":"Pre-Agreed","type":"string","description":"Type"}},"type":"object"},"BaseBalance":{"required":["amount","currency","type"],"properties":{"amount":{"title":"Amount of associated currency (positive for income and negative for expenditure)","example":"22.35","type":"number","format":"float","description":"Amount of associated currency (positive for income and negative for expenditure)"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"type":{"title":"Balance type (compatible with OpenBanking 3.1 specification)","example":"ClosingBooked","type":"string","enum":["ClosingAvailable","ClosingBooked","ClosingCleared","Expected","ForwardAvailable","Information","InterimAvailable","InterimBooked","InterimCleared","OpeningAvailable","OpeningBooked","OpeningCleared","PreviouslyClosedBooked","FriendlyScoreExpected"],"description":"Balance type (compatible with OpenBanking 3.1 specification)"},"custom_data":{"title":"Optional additional raw data (custom object).","example":{"some_field":"some_value"},"additionalProperties":true,"type":"object","description":"Optional additional raw data (custom object)."}},"type":"object"},"CreditLine2":{"required":["amount","included","type"],"properties":{"amount":{"title":"Amount","example":"100.54","type":"number","format":"float","description":"Amount"},"included":{"title":"Included","example":"false","type":"boolean","description":"Included"},"type":{"title":"Type","example":"Pre-Agreed","type":"string","description":"Type"}},"type":"object"},"ConsentData4":{"required":["consent_id","creation_date_time","status","status_update_date_time"],"properties":{"consent_id":{"title":"Unique identification as assigned to identify the account access consent resource.","type":"string","minLength":1,"description":"Unique identification as assigned to identify the account access consent resource."},"creation_date_time":{"title":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource was created. All dates in the JSON payloads are represented in UNIX timestamp format."},"status":{"title":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked.","type":"string","description":"Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked."},"status_update_date_time":{"title":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Date and time at which the resource status was updated. All dates in the JSON payloads are represented in UNIX timestamp format."},"expiration_date_time":{"title":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_from_date_time":{"title":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"transaction_to_date_time":{"title":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format.","example":"1553077496","type":"string","format":"date-time","description":"Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in UNIX timestamp format."},"consent_reconfirmation_date":{"title":"Last Consent reconfirmation date made by customer","example":"1553077496","type":"string","format":"date-time","description":"Last Consent reconfirmation date made by customer"}},"type":"object"},"PartyRelationships":{"properties":{"Account":{"$ref":"#\/definitions\/PartyRelatedAccount"}},"type":"object"},"PartyAddress":{"properties":{"AddressType":{"title":"Address Type","example":"DeliveryTo","type":"string","description":"Address Type"},"AddressLine":{"title":"Address Line","example":"[\u00271st Floor\u0027, \u0027Mayfair\u0027]","items":{"type":"string"},"type":"array","description":"Address Line"},"StreetName":{"title":"Street Name","example":"Brook Street","type":"string","description":"Street Name"},"BuildingNumber":{"title":"Building Number","example":"52","type":"string","description":"Building Number"},"PostCode":{"title":"Post Code","example":"W1K 5DS","type":"string","description":"Post Code"},"TownName":{"title":"Town Name","example":"London","type":"string","description":"Town Name"},"Country":{"title":"Country","example":"United Kingdom","type":"string","description":"Country"},"CountrySubDivision":{"title":"Country Sub Division","example":"South London","type":"string","description":"Country Sub Division"}},"type":"object"},"StatementFee":{"properties":{"Description":{"title":"Descriptions","example":"[\u0027description 1\u0027, \u0027description 2\u0027]","items":{"type":"string"},"type":"array","description":"Descriptions"},"CreditDebitIndicator":{"title":"Credit Debit Indicator","example":"123","type":"string","description":"Credit Debit Indicator"},"Type":{"title":"Type","example":"123","type":"string","description":"Type"},"Rate":{"title":"Rate","example":"123.23","type":"number","format":"double","description":"Rate"},"RateType":{"title":"Rate Type","example":"123","type":"string","description":"Rate Type"},"Frequency":{"title":"Frequency","example":"123","type":"string","description":"Frequency"},"Amount":{"title":"Amount","example":"50.23","type":"string","description":"Amount"},"Currency":{"title":"Currency","example":"GBP","type":"string","description":"Currency"}},"type":"object"},"StatementInterest":{"properties":{"Description":{"title":"Descriptions","example":"[\u0027description 1\u0027, \u0027description 2\u0027]","items":{"type":"string"},"type":"array","description":"Descriptions"},"CreditDebitIndicator":{"title":"Credit Debit Indicator","example":"123","type":"string","description":"Credit Debit Indicator"},"Type":{"title":"Type","example":"123","type":"string","description":"Type"},"Rate":{"title":"Rate","example":"123.23","type":"number","format":"double","description":"Rate"},"RateType":{"title":"Rate Type","example":"123","type":"string","description":"Rate Type"},"Frequency":{"title":"Frequency","example":"123","type":"string","description":"Frequency"},"Amount":{"title":"Amount","example":"50.23","type":"string","description":"Amount"},"Currency":{"title":"Currency","example":"GBP","type":"string","description":"Currency"}},"type":"object"},"StatementRate":{"properties":{"Rate":{"title":"Rate","example":"123","type":"string","description":"Rate"},"Type":{"title":"Type","example":"123","type":"string","description":"Type"}},"type":"object"},"StatementValue":{"properties":{"Value":{"title":"Value","example":"123","type":"string","description":"Value"},"Type":{"title":"Type","example":"123","type":"string","description":"Type"}},"type":"object"},"StatementDateTime":{"properties":{"Type":{"title":"Type","example":"123","type":"string","description":"Type"},"DateTime":{"title":"Date Time","example":"123","type":"string","description":"Date Time"}},"type":"object"},"StatementAmount":{"properties":{"CreditDebitIndicator":{"title":"Credit Debit Indicator","example":"123","type":"string","description":"Credit Debit Indicator"},"Type":{"title":"Type","example":"123","type":"string","description":"Type"},"Amount":{"title":"Amount","example":"50.23","type":"string","description":"Amount"},"Currency":{"title":"Currency","example":"GBP","type":"string","description":"Currency"}},"type":"object"},"StatementBenefit":{"properties":{"Type":{"title":"Type","example":"123","type":"string","description":"Type"},"Amount":{"title":"Amount","example":"50.23","type":"string","description":"Amount"},"Currency":{"title":"Currency","example":"GBP","type":"string","description":"Currency"}},"type":"object"},"BaseBalance2":{"required":["amount","currency","type"],"properties":{"amount":{"title":"Amount of associated currency (positive for income and negative for expenditure)","example":"22.35","type":"number","format":"float","description":"Amount of associated currency (positive for income and negative for expenditure)"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"type":{"title":"Balance type (compatible with OpenBanking 3.1 specification)","example":"ClosingBooked","type":"string","enum":["ClosingAvailable","ClosingBooked","ClosingCleared","Expected","ForwardAvailable","Information","InterimAvailable","InterimBooked","InterimCleared","OpeningAvailable","OpeningBooked","OpeningCleared","PreviouslyClosedBooked","FriendlyScoreExpected"],"description":"Balance type (compatible with OpenBanking 3.1 specification)"},"custom_data":{"title":"Optional additional raw data (custom object).","example":{"some_field":"some_value"},"additionalProperties":true,"type":"object","description":"Optional additional raw data (custom object)."}},"type":"object"},"ScoreWithCodes":{"properties":{"score":{"title":"Score","example":"700","type":"integer","description":"Score"},"band":{"title":"Band","example":"b","type":"string","description":"Band"},"reason_codes":{"title":"Reason codes","items":{"$ref":"#\/definitions\/ReasonCode"},"type":"array","description":"Reason codes"}},"type":"object"},"FinancialForecastBank":{"properties":{"name":{"title":"Bank name.","example":"PKO","type":"string","description":"Bank name."},"slug":{"title":"Bank slug (unique identifier)","example":"pko","type":"string","description":"Bank slug (unique identifier)"},"is_active":{"title":"Denotes if this bank can currently be used.","type":"boolean","description":"Denotes if this bank can currently be used."},"account":{"title":"Array of accounts","items":{"$ref":"#\/definitions\/Account4"},"type":"array","description":"Array of accounts"}},"type":"object"},"HistoricalAmount":{"properties":{"amount":{"title":"Amount of associated currency","example":"22.35","type":"number","format":"float","description":"Amount of associated currency"},"year":{"title":"Year","example":"2019","type":"integer","description":"Year"},"month":{"title":"Month","example":"11","type":"integer","description":"Month"}},"type":"object"},"IncomeCategoryData":{"properties":{"name":{"title":"Category name.","example":"Salary","type":"string","description":"Category name."},"monthly_amounts":{"title":"Array of amounts","items":{"$ref":"#\/definitions\/HistoricalAmount"},"type":"array","description":"Array of amounts"}},"type":"object"},"ExpenditureCategoryData":{"properties":{"name":{"title":"Category name.","example":"Hobby","type":"string","description":"Category name."},"fixed_flexible":{"title":"Info if this is a fixed or flexible\/variable expenditure.","description":"Flexible is used for personal accounts and variable for business accounts.","example":"fixed","type":"string","enum":["fixed","flexible"]},"monthly_amounts":{"title":"Array of amounts","items":{"$ref":"#\/definitions\/HistoricalAmount"},"type":"array","description":"Array of amounts"}},"type":"object"},"Recurrence":{"properties":{"description":{"title":"Transaction name or description","example":"Granny\u0027s Bakery","type":"string","description":"Transaction name or description"},"average_amount":{"title":"Amount of associated currency","example":"22.35","type":"number","format":"float","description":"Amount of associated currency"},"amount_variance":{"title":"Amount variance","example":"0.2","type":"number","format":"float","description":"Amount variance"},"transaction_ids":{"title":"Collection of related transaction data","items":{"type":"string"},"type":"array","description":"Collection of related transaction data"},"amount_stability_of_transaction":{"title":"Amount Consistency - Determines how consistent are the monthly amounts within the group. 100 means the values are the same.","type":"number","format":"float","description":"Amount Consistency - Determines how consistent are the monthly amounts within the group. 100 means the values are the same."},"frequency_stability_of_transaction":{"title":"Regularity - Determines how regular in time are transaction to each other. 100 means exactly the same period of time between transactions.","type":"number","format":"float","description":"Regularity - Determines how regular in time are transaction to each other. 100 means exactly the same period of time between transactions."},"time_stability_of_transaction":{"title":"Longevity - Determines for how long we have transactions in the group. 100 means the transactions occur in each of the last 12 months.","type":"number","format":"float","description":"Longevity - Determines for how long we have transactions in the group. 100 means the transactions occur in each of the last 12 months."},"expected_amount":{"title":"Expected amount","example":"210.0","type":"string","description":"Expected amount"},"expected_pay_date":{"title":"Expected pay date timestamp","example":"1656201600","type":"string","description":"Expected pay date timestamp"},"frequency":{"title":"Frequency of recurrence","example":"Irregular","type":"string","description":"Frequency of recurrence"}},"type":"object"},"CategoryPattern":{"properties":{"category":{"title":"Transaction category","example":"Groceries \u0026 Supplies","type":"string","description":"Transaction category"},"min":{"title":"Minimum amount","example":"5.05","type":"number","format":"float","description":"Minimum amount"},"mean":{"title":"Mean amount","example":"8.05","type":"number","format":"float","description":"Mean amount"},"max":{"title":"Maximum amount","example":"15.02","type":"number","format":"float","description":"Maximum amount"},"variance":{"title":"Variance","example":"0.5","type":"number","format":"float","description":"Variance"},"frequency":{"title":"Average number of transactions per month","example":"15.5","type":"number","format":"float","description":"Average number of transactions per month"},"continuity":{"title":"Largest number of consecutive transactions","example":"6","type":"integer","description":"Largest number of consecutive transactions"},"recency":{"title":"Months since transaction","example":"3","type":"integer","description":"Months since transaction"},"amount_stability_of_category":{"title":"Amount Consistency - Determines how consistent are the monthly amounts within the category. 1.0 means the values are the same.","example":"1.0","type":"number","format":"float","description":"Amount Consistency - Determines how consistent are the monthly amounts within the category. 1.0 means the values are the same."},"frequency_stability_of_category":{"title":"Regularity - Determines how regular in time are transactions in the category. 1.0 means exactly the same period of time between transactions.","example":"1.0","type":"number","format":"float","description":"Regularity - Determines how regular in time are transactions in the category. 1.0 means exactly the same period of time between transactions."},"time_stability_of_category":{"title":"Longevity - Determines for how long we have transactions in the category. 1.0 means the transactions occur in each of the last 12 months.","example":"1.0","type":"number","format":"float","description":"Longevity - Determines for how long we have transactions in the category. 1.0 means the transactions occur in each of the last 12 months."}},"type":"object"},"HistoricalCummulativeStat":{"properties":{"num_last_3m":{"$ref":"#\/definitions\/CummulativeStatDataPoint"},"num_last_6m":{"$ref":"#\/definitions\/CummulativeStatDataPoint"},"num_last_12m":{"$ref":"#\/definitions\/CummulativeStatDataPoint"}},"type":"object"},"AmountStat":{"properties":{"rate_of_change":{"title":"Variable which describes the rate of change of contributions from a given transaction category.","description":"This is calculated by comparing the most recent three-month average value to the average value over the period of evaluation","example":"0.66","type":"number","format":"float"},"pred_next_month":{"title":"Amount (Variable is deprecated)","example":"122.35","type":"number","format":"float","description":"Amount (Variable is deprecated)"},"ratio_to_income":{"title":"Average monthly payment from transaction category as a percentage of average monthly income","example":"0.07","type":"number","format":"float","description":"Average monthly payment from transaction category as a percentage of average monthly income"},"ratio_to_recurring_income":{"title":"Average monthly payment from transaction category as a percentage of average monthly recurring income","example":"0.07","type":"number","format":"float","description":"Average monthly payment from transaction category as a percentage of average monthly recurring income"},"total_amounts":{"title":"Total Amounts","additionalProperties":{"type":"string"},"type":"object","description":"Total Amounts"},"count":{"title":"Total Count of Incidents in the last 12 months","type":"integer","description":"Total Count of Incidents in the last 12 months"}},"type":"object"},"FinancialMarkersDataSummaryAverages":{"properties":{"average_fixed_exp":{"title":"Average fixed expenditure","type":"number","format":"float","description":"Average fixed expenditure"},"average_flexible_exp":{"title":"Average flexible expenditure","type":"number","format":"float","description":"Average flexible expenditure"},"average_income":{"title":"Average income","type":"number","format":"float","description":"Average income"},"average_recurring_income":{"title":"Average recurring income","type":"number","format":"float","description":"Average recurring income"},"predicted_amounts":{"$ref":"#\/definitions\/FinancialMarkersDataSummaryAveragesPredictedAmounts"}},"type":"object"},"SalaryExpectation":{"properties":{"amount":{"title":"Amount","example":"1220.35","type":"number","format":"float","description":"Amount"},"expected_pay_date":{"title":"Date\/time of expected payment","example":"1608418799","type":"string","format":"date-time","description":"Date\/time of expected payment"},"pay_frequency":{"title":"Pay frequency","example":"monthly","type":"string","description":"Pay frequency"}},"type":"object"},"ExpenseProportion":{"properties":{"fixed_proportion":{"title":"Fixed proportion","type":"number","format":"float","description":"Fixed proportion"},"flexible_proportion":{"title":"Variable proportion","type":"number","format":"float","description":"Variable proportion"}},"type":"object"},"IncomeProportion":{"properties":{"other_income_proportion":{"title":"Other income proportion","type":"number","format":"float","description":"Other income proportion"},"sales_proportion":{"title":"Sales proportion","type":"number","format":"float","description":"Sales proportion"},"services_proportion":{"title":"Services proportion","type":"number","format":"float","description":"Services proportion"}},"type":"object"},"BankConfiguration":{"properties":{"transactions_consent_from":{"title":"Number of months back relative to now, when the transactionFrom date will be set.","example":"36","type":"integer","description":"Number of months back relative to now, when the transactionFrom date will be set."},"transactions_consent_to":{"title":"Number of months forward relative to now, when the transactionTo date will be set.","example":"72","type":"integer","description":"Number of months forward relative to now, when the transactionTo date will be set."}},"type":"object"},"PartyRelatedAccount":{"properties":{"Related":{"title":"Related Account ID","example":"1234","type":"string","description":"Related Account ID"},"Id":{"title":"ID","example":"1234","type":"string","description":"ID"}},"type":"object"},"ReasonCode":{"properties":{"code":{"title":"Reason code","example":"RC1","type":"string","description":"Reason code"},"description":{"title":"Reason code description","example":"No Gambling Activity","type":"string","description":"Reason code description"},"sentiment":{"title":"Reason code\u0027s sentiment","example":"Positive","type":"string","enum":["Positive","Negative"],"description":"Reason code\u0027s sentiment"}},"type":"object"},"Account4":{"required":["id","currency","type","number","sort_code_and_account_number"],"properties":{"id":{"title":"Id","example":"123","type":"integer","description":"Id"},"currency":{"title":"Currency code (compatible with ISO 4217)","example":"GBP","type":"string","description":"Currency code (compatible with ISO 4217)"},"type":{"title":"Account type","example":"Personal","type":"string","enum":["Business","Personal"],"description":"Account type"},"number":{"title":"Account number","example":"12123412341234123412341234","type":"string","description":"Account number"},"sort_code_and_account_number":{"title":"Account sort code and number","example":"[\u0027sort_code\u0027 =\u003E 123456, \u0027account_number\u0027 =\u003E 12345678]","additionalProperties":true,"type":"object","description":"Account sort code and number"},"balance":{"$ref":"#\/definitions\/BalanceForecastData"}},"type":"object"},"CummulativeStatDataPoint":{"properties":{"timestamp_from":{"title":"Date\/time","example":"1600466400","type":"string","format":"date-time","description":"Date\/time"},"timestamp_to":{"title":"Date\/time","example":"1608418799","type":"string","format":"date-time","description":"Date\/time"},"count":{"title":"Count","example":"5","type":"integer","description":"Count"},"ratio_to_income":{"title":"Ratio to income","example":"5","type":"number","format":"float","description":"Ratio to income"},"total_amount":{"title":"Total amount","example":"5","type":"number","format":"float","description":"Total amount"}},"type":"object"},"FinancialMarkersDataSummaryAveragesPredictedAmounts":{"properties":{"fixed_expenses":{"type":"number","format":"float"},"flexible_expenses":{"type":"number","format":"float"},"income":{"type":"number","format":"float"},"recurring_income":{"type":"number","format":"float"}},"type":"object"},"BalanceForecastData":{"properties":{"actual":{"title":"Array of historical balances","items":{"$ref":"#\/definitions\/HistoricalAmount2"},"type":"array","description":"Array of historical balances"},"forecast":{"title":"Array of predicted balances","items":{"$ref":"#\/definitions\/HistoricalAmount2"},"type":"array","description":"Array of predicted balances"}},"type":"object"},"HistoricalAmount2":{"properties":{"amount":{"title":"Amount of associated currency","example":"22.35","type":"number","format":"float","description":"Amount of associated currency"},"date":{"title":"Date","example":"1600466400","type":"string","format":"date-time","description":"Date"}},"type":"object"}},"securityDefinitions":{"AppUserToken":{"name":"Authorization","type":"apiKey","in":"header","description":"Value: `AppUserToken {customer.token}`"},"Bearer":{"name":"Authorization","type":"apiKey","in":"header","description":"Value: `Bearer {oauth2.access_token}`"}}}