---
title: "List Payor Links"
method: GET
path: "/v1/payorLinks"
tags: ["Payor Hierarchy"]
---

# List Payor Links

`GET /v1/payorLinks`

If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy

## Query parameters

- `descendantsOfPayor` string, uuid
- `parentOfPayor` string, uuid
- `fields` string

## Response `200`

Details of Payor Links

- PayorLinksResponse — List Payor Links Response Object
  - `links` PayorLinksResponseLinks[]
    - `linkId` string, uuid, required
    - `fromPayorId` string, uuid, required
    - `linkType` string, required — The type of the link. One of the following values: PARENT_OF
    - `toPayorId` string, uuid, required
  - `payors` PayorLinksResponsePayors[]
    - `payorId` string, uuid, required
    - `payorName` string, required
    - `primaryContactEmail` string
    - `kycState` string — Current KYC state. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — The resource was not found or is no longer available

## Changes

- **2022-12-12** `3cf504795910` — 3 info
  - api operation id `payorLinks` removed and replaced with `payorLinksV1`
  - api tag `Payor Hierarchy` added
  - api tag `Payors` removed
- **2022-06-27** `1e7a1734a45c` — 4 info
  - removed the `FAILED_KYC` enum value from the `payors/items/kycState` response property for the response status `200`
  - removed the `PARENT_OF` enum value from the `links/items/linkType` response property for the response status `200`
  - removed the `PASSED_KYC` enum value from the `payors/items/kycState` response property for the response status `200`
  - removed the `REQUIRES_KYC` enum value from the `payors/items/kycState` response property for the response status `200`
- **2020-09-25** `dd71433847a6` — 3 breaking, 18 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - the `errors/items/` response's property type changed from no type to `object` for status `404`
  - added the optional property `errors/items/errorCode` to the response with the `400` status
  - …17 more
- **2020-06-24** `aded220b0d7b` — 2 breaking
  - the response's body type changed from `object` to no type for status `404`
  - the `errors/items/` response's property type changed from `object` to no type for status `404`
- …earlier changes not shown

[Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payorLinks/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/c9570437d66c?raw)