YAyapily
Financial Data

Get Account Beneficiaries

Returns all the beneficiaries of a user's account.

Feature: ACCOUNT_BENEFICIARIES

get/accounts/{accountId}/beneficiaries

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

accountIdstring required

Mandatory. The account Id of the user's bank account.

Headers

consentstring required

Mandatory. The consent-token containing the user's authorisation to make the request.

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Response

Ok

linksobject
tracingIdstring

Example response

{
  "data": [
    {
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.