> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnosispay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List KYC profiles

> Lists KYC profiles available to the authenticated partner.

Use `external_reference` to reconcile an interrupted onboarding flow. Results use
cursor pagination and are sorted by `created_at`, newest first.



## OpenAPI

````yaml https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles
openapi: 3.1.0
info:
  title: Gnosis Pay Partner API
  version: 1.0.0
  description: >-
    Server-to-server API for onboarding users, creating accounts and cards,
    moving

    funds, and managing the card lifecycle. Call this API only from a trusted

    backend. Every request requires a partner access token, and every resource
    is

    scoped to the authenticated partner.
servers:
  - url: https://core.prod.gnosispay.com/partner-api
    description: Production
    variables: {}
  - url: https://core.sandbox.gnosispay.in/core
    description: Sandbox
    variables: {}
security:
  - BearerAuth: []
tags:
  - name: Accounts
  - name: Cards
  - name: Card transactions
  - name: KYC
  - name: Deposits
  - name: Withdrawals
  - name: PCI
  - name: 3DS
  - name: Webhooks
paths:
  /v1/kyc/profiles:
    get:
      tags:
        - KYC
      summary: List KYC profiles
      description: >-
        Lists KYC profiles available to the authenticated partner.


        Use `external_reference` to reconcile an interrupted onboarding flow.
        Results use

        cursor pagination and are sorted by `created_at`, newest first.
      operationId: kyc_profiles.list.v1
      parameters:
        - name: external_reference
          in: query
          required: false
          description: Filter by your client-provided external reference.
          schema:
            $ref: '#/components/schemas/ExternalReference'
          explode: false
        - name: created_at_start
          in: query
          required: false
          description: Filter profiles created on or after this date.
          schema:
            type: string
            format: date-time
          explode: false
        - name: created_at_end
          in: query
          required: false
          description: Filter profiles created on or before this date.
          schema:
            type: string
            format: date-time
          explode: false
        - name: page_size
          in: query
          required: false
          description: The number of profiles on each page (1-100).
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 100
            default: 10
          explode: false
        - name: page_cursor
          in: query
          required: false
          description: >-
            The cursor of the page to return. Its value comes from
            `pagination.next_page_cursor` in the previous response.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Profile'
                  pagination:
                    $ref: '#/components/schemas/PaginationInfo'
                description: Paginated response containing data and pagination metadata
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ExternalReference:
      type: string
      minLength: 1
      maxLength: 128
      pattern: ^[A-Za-z0-9_-]+$
      description: >-
        Your identifier for reconciliation. 1 to 128 letters, digits,
        underscores or hyphens.
    Profile:
      type: object
      required:
        - id
        - email
        - status
        - created_at
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique KYC profile identifier.
        external_reference:
          $ref: '#/components/schemas/ExternalReference'
          description: Client-provided external reference.
        email:
          type: string
          description: Email address of the person being onboarded.
        status:
          $ref: '#/components/schemas/ProfileStatus'
          description: Current KYC profile status.
        created_at:
          type: string
          format: date-time
          description: When the profile was created.
    PaginationInfo:
      type: object
      required:
        - next_page_cursor
        - has_next
      properties:
        next_page_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Base64-encoded cursor for the next page, null if no more items
        has_next:
          type: boolean
          description: True if there are more items available
      description: Pagination metadata for cursor-based pagination
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code.
        message:
          type: string
          description: Generic human-readable text for the status code. Do not parse it.
        reason:
          type: string
          description: >-
            Stable machine-readable code identifying the specific cause, present
            only

            for errors that expose one (e.g. `CREATE_CARD_LIMIT_EXCEEDED`).
            Branch on

            this rather than on `message`.
    uuid:
      type: string
      format: uuid
    ProfileStatus:
      type: string
      enum:
        - pending
        - approved
        - blocked
        - rejected
        - requires_action
        - resubmission_requested
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.