---
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

---

[API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)