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

# KYC integration settings

> Returns whether hosted verification and BYOK share tokens are available, plus the share recipient id for generating identity share tokens.



## OpenAPI

````yaml /openapi.json get /v1/kyc/config
openapi: 3.1.0
info:
  title: Apocor Core API
  version: 1.0.0
  description: >-
    The Apocor Cards API is the integration surface for issuing and managing
    cards. Authenticate with your Apocor API key, onboard applicants, run KYC,
    and issue virtual or physical cards — all through one white-labeled API.
  contact:
    name: Apocor Support
    url: https://apocor.com
servers:
  - url: https://sandbox.apocor.ai
    description: Sandbox (live)
  - url: https://api.apocor.com
    description: Production
  - url: http://localhost:4000
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Exchange Apocor API keys for a short-lived access token.
  - name: Applicants
    description: End-users and businesses, plus their identity verification (KYC).
  - name: KYC
    description: >-
      Identity verification settings, hosted sessions, BYOK share tokens, and
      issuer readiness.
    x-group: Identity verification (KYC)
  - name: Accounts
    description: Funding accounts that back issued cards.
  - name: Programs
    description: Card programs that define product type, currency, and BIN.
  - name: Cardholders
    description: Approved applicants turned into cardholders.
  - name: Cards
    description: Issue and manage virtual and physical cards.
  - name: Transactions
    description: Card transaction history from the issuer or local ledger.
  - name: Sandbox
    description: Sandbox-only simulation helpers for testing authorizations and KYC.
  - name: Session
    description: The authenticated principal behind the current access token.
    x-group: Account & API keys
  - name: API Keys
    description: Create, list, and revoke the API keys used to obtain access tokens.
    x-group: Account & API keys
  - name: Organizations
    description: Tenants (integrators / sub-orgs) managed on the platform.
  - name: Billing
    description: Platform credit balance, funding wallets, and the pay-as-you-go ledger.
  - name: Onboarding
    description: Invite-token onboarding flow for new users (no access token required).
  - name: Webhooks
    description: >-
      Inbound events Apocor receives from upstream providers. Apocor verifies
      the signature and processes these asynchronously — you do not call them.
  - name: System
    description: Service health probes used by load balancers and uptime monitors.
paths:
  /v1/kyc/config:
    get:
      tags:
        - KYC
      summary: KYC integration settings
      description: >-
        Returns whether hosted verification and BYOK share tokens are available,
        plus the share recipient id for generating identity share tokens.
      operationId: getKycConfig
      responses:
        '200':
          description: KYC integration settings.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/KycConfig'
components:
  schemas:
    KycConfig:
      type: object
      properties:
        hostedVerificationAvailable:
          type: boolean
          description: Whether POST /v1/applicants/{id}/kyc-session is available.
        shareVerificationAvailable:
          type: boolean
          description: Whether POST /v1/applicants/{id}/kyc-share accepts share tokens.
        shareRecipientId:
          type:
            - string
            - 'null'
          description: >-
            Apocor Sumsub client id for BYOK share tokens (forClientId in your
            identity provider). Never the upstream card-program id.
        sumsubWebhookMode:
          type: string
          enum:
            - seismic
            - apocor
          description: >-
            Where Sumsub webhook events are received (seismic-cards on Railway
            by default).
        sumsubWebhookUrl:
          type:
            - string
            - 'null'
          description: Public Sumsub webhook URL to register in the Sumsub dashboard.
        verificationSync:
          type: string
          description: >-
            How to sync Apocor applicants after hosted verification when using
            seismic webhooks.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer access token obtained from `POST /v1/oauth/token` using your
        Apocor API key.

````