---
title: "Get all KYC links."
method: GET
path: "/kyc_links"
tags: ["KYC Links"]
---

# Get all KYC links.

`GET /kyc_links`

Retrieve the full list of kyc links.

## Query parameters

- `customer_id` string
- `email` string
- `starting_after` string
- `ending_before` string
- `limit` integer

## Response `200`

Successful KYC links status response

- object
  - `count` integer, required — total number of items in data
  - `data` IndividualKycLinkResponse[], required
    - `id` string — ID of the KYC link
    - `type` 'individual' | 'business' — Type of the KYC link
    - `customer_id` string — ID of the customer.
    - `full_name` string — Full name of the customer, for a business, this would be the business entity's legal name
    - `email` string — Email of the customer
    - `kyc_link` string — Link to the KYC flow
    - `kyc_status` 'not_started' | 'incomplete' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'under_review' | 'approved' | 'rejected' | 'paused' | 'offboarded' — Status of the KYC flow.
    - `rejection_reasons` RejectionReason[] — Reasons why a customer KYC was rejected
      - `developer_reason` string — Developer information for why a customer was rejected. Not to be shared with the customer.
      - `reason` string — Reason for why a customer was rejected. To be shared with the customer.
      - `created_at` string, nullable — Time of creation of the rejection reason
    - `tos_link` string — Link to the TOS flow
    - `tos_status` 'pending' | 'approved' — Status of the TOS flow
    - `created_at` string, date-time — Time of creation of the KYC link

## Other responses

- `401` — Missing or invalid API key
- `404` — No resource found
- `500` — Unexpected error. User may try and send the request again.

---

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