Retrieval of the trusted beneficiaries list

GET /api/v1/trusted-beneficiaries

Headers

X-Request-ID string Required

Correlation header to be set in a request and retrieved in the relevant response

Responses

200

HalTrustedBeneficiaries
Hide response attributes Show response attributes object
- _links Elixir.OpenBankingWeb.Schemas.HalLinks Required
  
  HAL Links
- beneficiaries array[object] Required
  
  One owner of user account
  
  Hide beneficiaries attributes Show beneficiaries attributes array[object]
  
  first_name string
  
  First name
  
  full_name string Required
  
  Full name
  
  last_name string
  
  Last name
  
  name_prefix string
  
  Name Prefix

GET /api/v1/trusted-beneficiaries

curl \
 -X GET https://iban.nash.io/api/v1/trusted-beneficiaries \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "X-Request-ID: string"

Response examples (200)

{
  "_links": {
    "self": {
      "href": "/v1/accounts"
    }
  },
  "beneficiaries": [
    {
      "creditor": {
        "currency": "EUR",
        "iban": "YY64COJH41059545330222956960771321"
      },
      "creditor_account": {
        "currency": "EUR",
        "iban": "YY64COJH41059545330222956960771321"
      },
      "id": "69581b46-bcc4-4361-b471-69205f24bc56",
      "is_trusted": true
    }
  ]
}

Response examples (200)

{
  "_links": {
    "self": {
      "href": "/v1/accounts"
    }
  },
  "beneficiaries": [
    {
      "id": "69581b46-bcc4-4361-b471-69205f24bc56",
      "creditor": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      },
      "is_trusted": true,
      "creditor_account": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      }
    }
  ]
}