How to perform account verification with Check

📘
Please note, the name field in the accounts endpoint and the parties endpoint within the OBIE specification are optional, therefore our market coverage differs between our Connect and Check products. You can find a list of all providers supported by our Check product here.

Below we’ll provide you with a step-by-step guide to help you perform Account Verification when using Connect. This can be performed whether you're using Bud Connect or have built out your own customer interface in the case that you have your own license (as an AISP).

Before starting you’ll need:

to have setup Connect - for further details on how to do this, please refer to this guide if you plan to use Bud Connect, or this guide, if you’re registered as an AISP and will be using your own customer interface; and
a valid OAuth access token - for further details on how to authenticate to Bud’s APIs please see this guide; and
a valid customer_id associated with your ‘Project’ (API Credentials). For further details on how to register a customer, please refer to this guide.

Retrieving your customer's name using Accounts v3

Once your customer has connected their account(s) you can retrieve the associated account information by using the GET /financial/v3/accounts endpoint (here) you will find your customer's name within the holders object. In the case that your customer’s provider supports the OBIE parties endpoint and you're contracted to use Check you will receive the name of all customers attached to the account along with their relationship to the account (joint, sole, delegate), if the provider does not support the parties endpoint you will receive the name of the customer who connected the account with the relationship set to unknown.

{
  "operation_id": "financial_v3_accounts",
  "data": [
    {
      "account_id": "RxsYshVGded4JeilkXgWKdXA",
      "currency": "GBP",
      "holders": [
        {
          "name": "David Smith",
          "relationship": "joint"
        },
        {
          "name": "Jane Smith",
          "relationship": "joint"
        }
      ],
      "account_name": "Household Account",
      "account_type": "current_account",
      "usage_type": "personal",
      "provider": "BankOfBud",
      "identifiers": {
        "uk_sort_code": "124332",
        "uk_account_number": "12642318"
      },
      "balances": {
        "booked": {
          "date": "2023-01-12T00:00:00Z",
          "amount": {
            "value": "3552.61",
            "currency": "GBP"
          },
          "credit_debit_indicator": "credit"
        },
        "pending": {
          "date": "2023-01-12T00:00:00Z",
          "amount": {
            "value": "3552.61",
            "currency": "GBP"
          },
          "credit_debit_indicator": "credit"
        }
      },
      "credit_lines": {
        "limit": {
          "date": "2023-01-12T00:00:00Z",
          "amount": {
            "value": "1000.00",
            "currency": "GBP"
          }
        }
      }
    }
  ],
  "metadata": {
    "parameters": {
      "currencies": [
        "GBP"
      ]
    },
    "results": 1
  }
}

Retrieving your customer’s name using Accounts v2

If you're using the old Accounts V2 endpoint you can retrieve the name of your customer by looking at the account holder(s) object. By default the name of the object will be holder, however if the provider supports the parties endpoint and you're contracted to use Check, the name will be holders.

📘
Tesco and Santander support the parties endpoint but they only return the name of the customer who has shared the account.

{
  "operation_id": "financial_v2_accounts",
  "data": [
    {
      "account_id": "928fed73-2eb9-4910-8a26-22b6c76fb9fa",
      "currency": "GBP",
      "holders": [
        {
          "name": "David Smith",
          "relationship": "joint"
        },
        {
          "name": "Jane Smith",
          "relationship": "joint"
        }
      ],
      "account_name": "Household Account",
      "account_type": "current_account",
      "usage_type": "personal",
      "provider": "BankOfBud",
      "identifiers": {
        "uk_sort_code": "124332",
        "uk_account_number": "12642318"
      },
      "balances": [
        {
          "date": "2023-01-12T00:00:00Z",
          "amount": {
            "value": "3552.61",
            "currency": "GBP"
          },
          "type": "interim_booked",
          "credit_debit_indicator": "credit"
        },
        {
          "date": "2023-01-12T00:00:00Z",
          "amount": {
            "value": "3552.61",
            "currency": "GBP"
          },
          "type": "expected",
          "credit_debit_indicator": "credit"
        }
      ],
      "credit_lines": [
        {
          "date": "2023-01-12T00:00:00Z",
          "type": "credit",
          "amount": {
            "value": "1000.00",
            "currency": "GBP"
          }
        }
      ]
    }
  ],
  "metadata": {
    "parameters": null,
    "result_count": 1
  }
}

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.