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

# Get KYC

> Retrieve the Know Your Customer (KYC) details for a specific user.

This endpoint:
- Validates the platform-user relationship
- Fetches the KYC record associated with the given user ID
- Returns the KYC information if found, otherwise raises a 404 error



## OpenAPI

````yaml GET /api/platform/users/kyc/{user_id}
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: http://localhost:8001
  - url: https://api.pw.wintpay.com
  - url: https://test.pw.wintpay.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/users/kyc/{user_id}:
    get:
      tags:
        - Platform Users
      summary: Get KYC of a user
      description: |-
        Retrieve the Know Your Customer (KYC) details for a specific user.

        This endpoint:
        - Validates the platform-user relationship
        - Fetches the KYC record associated with the given user ID
        - Returns the KYC information if found, otherwise raises a 404 error
      operationId: get_user_kyc_api_platform_users_kyc__user_id__get
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique identifier (UUID) of the user whose KYC record is being
              retrieved.
            title: User Id
          description: >-
            Unique identifier (UUID) of the user whose KYC record is being
            retrieved.
          example: f47ac10b-****-****-****-0e02b2c3d479
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_PlatformKycRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CommonResponse_PlatformKycRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - $ref: '#/components/schemas/PlatformKycRead'
            - type: 'null'
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1782303609.673092
          example: 1718006400
      type: object
      title: CommonResponse[PlatformKycRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlatformKycRead:
      properties:
        user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: User Id
          description: UUID of the user undergoing KYC verification
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: User's legal first name
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: User's legal last name
        dob:
          anyOf:
            - type: string
            - type: 'null'
          title: Dob
          description: Date of birth in YYYY-MM-DD format
        phone_no:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone No
          description: User’s phone number including country code
        ssn:
          anyOf:
            - type: string
            - type: 'null'
          title: Ssn
          description: Last 4 digits of the user's SSN (if applicable)
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: Residential address of the user
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          description: City of the user's residence
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
          description: State or province of the user's residence
        zip:
          anyOf:
            - type: string
            - type: 'null'
          title: Zip
          description: ZIP or postal code of the user's address
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Country of the user's residence (e.g., 'US')
        id_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Id Type
          description: Type of identity document (e.g., 'passport', 'driver_license')
        selfie:
          anyOf:
            - type: string
            - type: 'null'
          title: Selfie
          description: URL or base64-encoded image of user's selfie
        id_front_img:
          anyOf:
            - type: string
            - type: 'null'
          title: Id Front Img
          description: URL or base64-encoded image of front side of ID document
        id_back_img:
          anyOf:
            - type: string
            - type: 'null'
          title: Id Back Img
          description: URL or base64-encoded image of back side of ID document
        kyc_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Kyc Status
          description: KYC status of the user (e.g., 'PENDING', 'APPLIED')
      type: object
      title: PlatformKycRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````