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

> Retrieves a KYC profile and its verified details when available.

Use the profile `status` to control onboarding. Create an account only
after the profile is `approved` and the required onboarding steps are complete.



## OpenAPI

````yaml https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_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}:
    get:
      tags:
        - KYC
      summary: Get a KYC profile
      description: >-
        Retrieves a KYC profile and its verified details when available.


        Use the profile `status` to control onboarding. Create an account only

        after the profile is `approved` and the required onboarding steps are
        complete.
      operationId: kyc_profiles.get.v1
      parameters:
        - name: kyc_profile_id
          in: path
          required: true
          description: The unique identifier of the KYC profile.
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileWithDetails'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    uuid:
      type: string
      format: uuid
    ProfileWithDetails:
      type: object
      required:
        - id
        - email
        - status
        - details
      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.
        details:
          anyOf:
            - $ref: '#/components/schemas/ProfileDetails'
            - type: 'null'
          description: Verified profile details; null until they are available.
    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`.
    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.
    ProfileStatus:
      type: string
      enum:
        - pending
        - approved
        - blocked
        - rejected
        - requires_action
        - resubmission_requested
    ProfileDetails:
      type: object
      required:
        - full_name
        - phone_number
        - date_of_birth
        - nationality
        - country_of_residence
        - country_of_birth
        - document_number
        - gender
        - addresses
      properties:
        full_name:
          type: string
          description: User's verified full name.
        phone_number:
          type: string
          description: User's verified phone number.
        date_of_birth:
          type: string
          format: date-time
          description: User's date of birth.
        nationality:
          type: string
          description: User's nationality.
        country_of_residence:
          type: string
          description: User's country of residence.
        country_of_birth:
          type: string
          description: User's country of birth.
        document_number:
          type: string
          description: User's identity-document number.
        gender:
          type: string
          description: User's gender, as recorded during verification.
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/Address'
          description: User's verified addresses.
    Address:
      type: object
      required:
        - id
        - country
        - postal_code
        - city
        - state
        - address1
        - address2
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique address identifier.
        country:
          type: string
          description: ISO 3166 country code.
        postal_code:
          type: string
          description: Postal code.
        city:
          type: string
          description: City.
        state:
          type: string
          description: State, province, or region.
        address1:
          type: string
          description: Primary address line.
        address2:
          anyOf:
            - type: string
            - type: 'null'
          description: Additional address line, when available.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer

````

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