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

# Get KYC Widget URL

> This endpoint returns a URL that redirects the user to perform document-based KYC verification.



## OpenAPI

````yaml /api_reference/onramp.yaml get /kyc/widgetUrl
openapi: 3.0.3
info:
  version: '1.0'
  title: Crypto API
  description: Reference for Sardine Crypto API
  contact:
    email: support@sardine.io
    name: Sardine
    url: docs.sardine.io
servers:
  - url: https://api.sandbox.sardine.ai/v1
    description: Sandbox
  - url: https://api.sardine.ai/v1
    description: Prod Server
security: []
paths:
  /kyc/widgetUrl:
    get:
      tags:
        - User Onboarding
      summary: Get KYC Widget URL
      description: >-
        This endpoint returns a URL that redirects the user to perform
        document-based KYC verification.
      operationId: get-kyc-widget-url
      parameters:
        - name: userId
          in: query
          description: The ID of the user for whom the KYC URL is being requested
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response with KYC redirect URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  kycUrl:
                    type: string
                    description: URL to redirect the user to complete KYC
                    format: uri
              examples:
                example-1:
                  value:
                    kycUrl: https://kyc-widget.sardine.ai/start?sessionId=abc123
      security: []
      servers:
        - url: https://api.sandbox.sardine.ai/v1
          description: Sandbox
        - url: https://api.sardine.ai/v1
          description: Prod Server

````