FriendlyScore - Production API

Number of APIs: 46

Introduction

FriendlyScore’s API is a simple way to offer Open Banking PSD2 connectivity services and access customer identity, account, transaction and balance data from all integrated banks in the United Kingdom.

Data available:

The FriendlyScore API allows you to access the following data from connected accounts:

  • Account: account holder name, account number, IBAN, e-mail address, mobile number, address and other KYC information
  • Credit card: card network, last four digits, name on card
  • Transactions: description, amount, category, date and more
  • Balances: current and historical
  • Insights: personal (employment, income, salary verification and financial markers), and business (payroll and financial markers)
  • Forecast: financial credibility score (ability to make credit repayments), liquidity score (solvency forecast for 30, 60 and 90 days), financial balance prediction (for 30, 60 and 90 days)

Additional API features: - WebComponent Javascript URL: integrate securely on the web - Customer Invitations: generate an invitation link or let FriendlyScore send an - automated invitation e-mail - Transaction categorisation: manually update the categorisation result for a specific group of transactions - Upload your own data: allow FriendlyScore to categorise and build analytics for your own internal bank transaction data

Coverage:

We provide connectivity to all major banks in the United Kingdom.

  1. 1. Authentication - Returns OAuth 2.0 token POST {{protocol}}://{{api-hostname}}/oauth/v2/token

  2. 2. Customers - Create Customer POST {{protocol}}://{{api-hostname}}/public/v3/customers

  3. 8. Invitations - Post new invitation POST {{protocol}}://{{api-hostname}}/public/v3/invitations

  4. 2. Customers - Create Customer Token POST {{protocol}}://{{api-hostname}}/public/v3/customers/{{customer_id}}/token

  5. 3. Banks And Categories - Get Categories GET {{protocol}}://{{api-hostname}}/public/v3/account_types/{{account_type}}/transaction_categories

  6. 2. Customers - Get Customers GET {{protocol}}://{{api-hostname}}/public/v3/customers

  7. 2. Customers - Delete Customer DELETE {{protocol}}://{{api-hostname}}/public/v3/customers/{{customer_id}}/delete

  8. 3. Banks And Categories - Get Banks GET {{protocol}}://{{api-hostname}}/public/v3/banks

  9. 4. Post Your Own Data - Post Bank Accounts POST {{protocol}}://{{api-hostname}}/public/v3/customers/{{customer_id}}/account_collections

  10. 4. Post Your Own Data - Post Bank Balances POST {{protocol}}://{{api-hostname}}/public/v3/customers/{{customer_id}}/balance_collections