---
title: "List KYC sessions"
method: GET
path: "/api/v1/partner/kyc-sessions"
tags: ["Partner API"]
---

# List KYC sessions

`GET /api/v1/partner/kyc-sessions`

## Query parameters

- `status` 'email_sent' | 'link_ready' | 'opened' | 'in_progress' | 'kyc_completed' | 'revoked'
- `account_auth_id` string
- `page` integer
- `size` integer

## Response `200`

Sessions list

- object
  - `sessions` object[], required
    - `id` string, required
    - `account_auth_id` string, required
    - `customer_email` string, nullable, required
    - `kyc_type` string, nullable, required
    - `status` string, required
    - `expires_at` string, required
    - `first_opened_at` string, nullable, required
    - `completed_at` string, nullable, required
    - `webhook_url` string, nullable, required
    - `redirect_url` string, nullable, required
    - `reminder_schedule` object[], required
      - `value` integer, required
      - `trigger` string, required
    - `metadata` union, required
      - unknown
      - object
        - `plan` string, required
        - `customer_ref` string, required
    - `verified_data` union, required
      - unknown
      - object
        - `pan_type` string
        - `pan_number` string
        - `pan_name_match` boolean
        - `completed_steps` string[]
        - `pan_registered_name` string
        - `gender` string
        - `address` string
        - `aadhaar_dob` string
        - `aadhaar_name` string
        - `masked_aadhaar` string
        - `pan_name` string
    - `created_at` string, required
    - `updated_at` string, required
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) · [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vobiz/vobiz-api/revisions/863f08cd6737/schema)