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

# Get a KYC check

> Retrieves a KYC check and, when requested, credentials for completing it.

Pass `include_credentials` only for the client experience you use. Treat
returned credentials as short-lived secrets and do not log them. For a
resubmission, retrieve fresh credentials before sending the user back to
the verification flow. If the check does not belong to the KYC profile,
the response is 404.



## OpenAPI

````yaml https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}
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/{kyc_profile_id}/checks/{check_id}:
    get:
      tags:
        - KYC
      summary: Get a KYC check
      description: >-
        Retrieves a KYC check and, when requested, credentials for completing
        it.


        Pass `include_credentials` only for the client experience you use. Treat

        returned credentials as short-lived secrets and do not log them. For a

        resubmission, retrieve fresh credentials before sending the user back to

        the verification flow. If the check does not belong to the KYC profile,

        the response is 404.
      operationId: kyc_profiles.get_check.v1
      parameters:
        - name: kyc_profile_id
          in: path
          required: true
          description: The unique identifier of the KYC profile.
          schema:
            $ref: '#/components/schemas/uuid'
        - name: check_id
          in: path
          required: true
          description: The unique identifier of the KYC check.
          schema:
            $ref: '#/components/schemas/uuid'
        - name: include_credentials
          in: query
          required: false
          description: Include SDK credentials in the response.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CheckCredential'
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCheckResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    uuid:
      type: string
      format: uuid
    CheckCredential:
      type: string
      enum:
        - mobile_sdk_token
        - web_sdk_url
    GetCheckResponse:
      type: object
      required:
        - check
      properties:
        check:
          $ref: '#/components/schemas/Check'
          description: Current check state.
        mobile_sdk_token:
          type: string
          description: Token for a native mobile verification experience, when requested.
        web_sdk_url:
          type: string
          description: URL for a hosted web verification experience, when requested.
    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`.
    Check:
      type: object
      required:
        - id
        - kyc_profile_id
        - type
        - status
        - block_at
        - created_at
        - updated_at
        - version
        - reject_labels
        - comments
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique check identifier.
        kyc_profile_id:
          $ref: '#/components/schemas/uuid'
          description: KYC profile associated with the check.
        type:
          $ref: '#/components/schemas/CheckType'
          description: Check category.
        status:
          $ref: '#/components/schemas/CheckStatus'
          description: Current check status.
        block_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Time at which the check became required, when applicable.
        created_at:
          type: string
          format: date-time
          description: When the check was created.
        updated_at:
          type: string
          format: date-time
          description: When the check was last updated.
        version:
          type: integer
          format: int32
          description: Version of this check record.
        reject_labels:
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          description: >-
            Machine-readable review labels. Present only when further action is
            required or verification was not approved.
        comments:
          anyOf:
            - type: string
            - type: 'null'
          description: User-facing explanation of the review outcome, when available.
    CheckType:
      type: string
      enum:
        - basic
        - terms
        - source_of_funds
    CheckStatus:
      type: string
      enum:
        - pending
        - approved
        - 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.