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

# Submit KYC

> Retrieve a verification link to initiate or resume identity verification for a specific user.

This endpoint:
- Returns a `inquiry_url` if the user’s verification is pending
- Indicates `is_kyc_pending = false` if no further action is required

**Usage Notes:**
- Open the returned URL in a new browser window or embed it in an iframe
- Use this only when the user has not completed their verification process



## OpenAPI

````yaml GET /api/platform/persona/platform-user/inquiry/{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/persona/platform-user/inquiry/{user_id}:
    get:
      tags:
        - Platform KYC
      summary: Create or resume a Persona inquiry for a platform user
      description: >-
        Retrieve a verification link to initiate or resume identity verification
        for a specific user.


        This endpoint:

        - Returns a `inquiry_url` if the user’s verification is pending

        - Indicates `is_kyc_pending = false` if no further action is required


        **Usage Notes:**

        - Open the returned URL in a new browser window or embed it in an iframe

        - Use this only when the user has not completed their verification
        process
      operationId: >-
        create_platform_user_inquiry_api_platform_persona_platform_user_inquiry__user_id__get
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique identifier (UUID) of the user for whom KYC verification is
              being initiated or resumed.
            title: User Id
          description: >-
            Unique identifier (UUID) of the user for whom KYC verification is
            being initiated or resumed.
          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_PlatformInquiryPayload_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CommonResponse_PlatformInquiryPayload_:
      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/PlatformInquiryPayload'
            - 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[PlatformInquiryPayload]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlatformInquiryPayload:
      properties:
        inquiry_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Inquiry Url
          description: >-
            Endpoint URL for initiating the user's identity verification as part
            of KYC compliance.
          example: >-
            https://withpersona.com/verify?inquiry-id=inq_uRe3YX5eytvZGpJhMefHB5saWxXe
        is_kyc_pending:
          type: boolean
          title: Is Kyc Pending
          description: >-
            Indicates whether the user's KYC (Know Your Customer) verification
            is still pending.
          default: true
          example: true
      type: object
      title: PlatformInquiryPayload
    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

````