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

# Initiate KYC onboarding

> Creates or retrieves a Noah hosted onboarding session for the authenticated
client.




## OpenAPI

````yaml /openapi/client-api.yaml post /clients/me/integrations/noah/customers/kyc
openapi: 3.1.0
info:
  title: Portal Client API
  version: '3.0'
  description: >
    The Portal Client API provides endpoints for managing wallets, building
    transactions,

    and interacting with blockchain networks. All endpoints require
    authentication via a

    Client API Key or Client Session Token (CST) passed as a Bearer token.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Client API Key or Client Session Token as a Bearer token in the

    `Authorization` header of every request.


    ## Chain ID Format

    Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or
    CAIP-2 format

    (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using
    CAIP-2 format

    in URLs, ensure the colon is URI-encoded (`%3A`).
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Clients
    description: Core client management endpoints
  - name: Wallet
    description: >-
      Read wallet state — balances, NFTs, transaction history, capabilities, and
      transaction details
  - name: Transactions
    description: Build, broadcast, and evaluate blockchain transactions
  - name: Funding
    description: Fund wallets with testnet tokens
  - name: Wallet Shares
    description: Manage signing and backup share pairs
  - name: Delegations
    description: Manage token approvals, revocations, and delegated transfers
  - name: Session Keys
    description: Manage EIP-7702 session keys for smart accounts
  - name: 0x
    description: Token swap endpoints powered by the 0x protocol
  - name: Yield.xyz
    description: Yield opportunities and staking actions powered by Yield.xyz
  - name: Li.Fi
    description: Cross-chain swaps and bridging powered by Li.Fi
  - name: Blockaid
    description: Transaction and address security scanning powered by Blockaid
  - name: Hypernative
    description: >-
      Transaction, address, token, and NFT security scanning powered by
      Hypernative
  - name: Noah
    description: KYC onboarding, payins, and payouts powered by Noah
  - name: Meld
    description: Buy and sell crypto with fiat through aggregated providers powered by Meld
  - name: EIP-7702
    description: EIP-7702 account type detection and authorization management
  - name: Deprecated
    description: >-
      Legacy endpoints scheduled for removal. Use the newer equivalents listed
      in each endpoint's description.
paths:
  /clients/me/integrations/noah/customers/kyc:
    post:
      tags:
        - Noah
      summary: Initiate KYC onboarding
      description: >
        Creates or retrieves a Noah hosted onboarding session for the
        authenticated

        client.
      operationId: initiateNoahKyc
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoahInitiateKycRequest'
      responses:
        '200':
          description: KYC onboarding session retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoahInitiateKycResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    NoahInitiateKycRequest:
      type: object
      required:
        - returnUrl
      properties:
        returnUrl:
          type: string
          format: uri
          pattern: ^https://
          description: HTTPS return URL used after hosted onboarding.
        fiatOptions:
          type: array
          description: Optional list of fiat options for onboarding.
          items:
            type: object
            required:
              - fiatCurrencyCode
            properties:
              fiatCurrencyCode:
                type: string
        customerType:
          type: string
          enum:
            - Individual
            - Business
        metadata:
          type: object
          additionalProperties: true
        form:
          type: object
          additionalProperties: true
    NoahInitiateKycResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            hostedUrl:
              type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Client API Key or Client Session Token (CST). Pass as a Bearer token in
        the

        Authorization header.

````