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

# Create User Onboarding Session

> Create a new user onboarding session and generate a hosted KYC link. This endpoint is used for the hosted KYC flow where users complete verification through a pre-built compliance interface. The returned onboarding URL redirects users to complete their KYC verification.



## OpenAPI

````yaml /api-reference/openapi.json post /onboarding/api/v1/users/session
openapi: 3.0.0
info:
  title: Carbn Connect API
  version: 1.0.0
  description: >-
    API documentation for Carbn Connect services including user onboarding, KYC,
    wallet management, and transfers.
servers:
  - url: https://api.carbnconnect.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /onboarding/api/v1/users/session:
    post:
      tags:
        - User Management
      summary: Create User Onboarding Session
      description: >-
        Create a new user onboarding session and generate a hosted KYC link.
        This endpoint is used for the hosted KYC flow where users complete
        verification through a pre-built compliance interface. The returned
        onboarding URL redirects users to complete their KYC verification.
      operationId: createUserSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSessionRequest'
      responses:
        '200':
          description: User session created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSessionResponse'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized - API key is missing or invalid
      security:
        - ApiKeyAuth: []
components:
  schemas:
    UserSessionRequest:
      type: object
      required:
        - email
        - currency
        - redirect_url
      properties:
        email:
          type: string
          format: email
          example: sachimnm4083@gmail.com
          description: User's email address for the onboarding session
        currency:
          type: string
          example: EUR
          description: Currency code (ISO 4217) for the user's preferred currency
        redirect_url:
          type: string
          format: uri
          example: https://www.carbn.xyz/
          description: >-
            URL to redirect the user to after completing the KYC verification
            process
    UserSessionResponse:
      type: object
      properties:
        onboarding_url:
          type: string
          format: uri
          example: >-
            https://checkout.noah.com/kyc?session=eyJhbGciOiJFUzM4NCIsImtpZCI6ImttcyIsInR5cCI6IkpXVCJ9...
          description: >-
            Hosted KYC verification URL where the user can complete their
            onboarding. This URL contains a session token and should be opened
            in a browser.
        user_id:
          type: string
          format: uuid
          example: 9e58ad24-a7a6-43b2-b1a9-984a410a87f3
          description: >-
            Unique identifier for the user session. This ID can be used to track
            the user's onboarding status.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Must be included in the x-api-key header.

````