---
title: "Get all users beneficiaries"
method: GET
path: "/users/{userId}/beneficiaries"
tags: ["User Beneficiaries"]
---

# Get all users beneficiaries

`GET /users/{userId}/beneficiaries`

Get all users beneficiaries from an userId.

## Path parameters

- `userId` string, uuid, required

## Response `200`

OK

- object — The user beneficiary response.
  - `meta` ResponseListMeta
    - `tracingId` string
    - `count` integer
    - `pagination` Pagination
      - `totalCount` integer
      - `self` FilterAndSort
        - `from` string, date-time — __Optional__. The earliest date and time of resources / records that should be returned.
        - `before` string, date-time — __Optional__. The latest date and time of resources / records that should be returned.
        - `limit` integer — __Optional__. The maximum number of resources / records that should be returned.
        - `sort` 'date' | '-date' — The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
        - `offset` integer
        - `cursor` string
      - `next` Next
        - `from` string, date-time
        - `before` string, date-time
        - `limit` integer
        - `cursor` string
  - `data` UserBeneficiaryData[]
    - `beneficiaryId` string, uuid — id of the beneficiary
    - `status` 'PENDING' | 'VERIFIED' | 'REJECTED' — Status of the beneficiary check.
    - `details` object — Beneficiary response with the details of the VoP result.
      - `name` string, required — name of the beneficiary
      - `match` UserBeneficiaryMatch — Details of the match given by the institution.
        - `status` 'FULL_MATCH' | 'CLOSE_MATCH' | 'NO_MATCH' | 'EXEMPTED' | 'VERIFICATION_CHECK_NOT_POSSIBLE'
        - `closeMatchName` string — the name returned by the institution, in a case of CLOSE_MATCH
      - `accountIdentifier` AccountIdentifier, required — Account's details.
        - `type` 'IBAN', required
        - `identification` string, required — Account's IBAN

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal error

---

[API](https://skmtc.net/yapily/apis/yapily-api.md) · [All operations](https://skmtc.net/yapily/apis/yapily-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yapily/yapily-api/versions/a8ca54f9eb9f/schema)