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

# Get KYC status

> Retrieve the store's current identity-verification (KYC) status. Requires the READ_KYC scope.

Returns the store's current verification status with its active session details and timestamps. The store is bound to your app token server-side — never send a shop id.


## OpenAPI

````yaml GET /kyc/status
openapi: 3.1.0
info:
  title: Salesive Apps API — Account
  version: 1.0.0
  description: >-
    Read the store's account configuration — domains, staff roles and payout
    methods — and manage its identity verification (KYC) from an installed
    third-party app. Every endpoint authenticates with an installed-app access
    token (prefix `app_`) and requires a specific OAuth scope. The target store
    is bound to the token server-side from the installation — never send a shop
    id. Domains, roles and payouts are read-only for apps: their
    create/update/delete operations are owner-only and are not exposed here.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
paths:
  /kyc/status:
    get:
      tags:
        - KYC
      summary: Get KYC status
      description: >-
        Returns the current identity-verification (KYC) status for the store,
        along with the active verification session id and URL (when one exists)
        and the relevant timestamps. Requires the `READ_KYC` scope and returns
        403 if the token is missing it. The store is bound to the app token
        server-side from the installation — never send a shop id.
      operationId: getKycStatus
      responses:
        '200':
          description: The store's current KYC status.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/KycStatus'
              example:
                status: 200
                success: true
                message: KYC status retrieved
                data:
                  status: pending
                  sessionId: sess_abc123
                  sessionUrl: https://verification.didit.me/session/sess_abc123
                  submittedAt: '2026-06-20T10:00:00.000Z'
                  verifiedAt: null
                  declinedAt: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    KycStatus:
      type: object
      description: >-
        The store's identity-verification (KYC) status and active session
        details.
      properties:
        status:
          type: string
          description: Verification status.
          enum:
            - not_started
            - pending
            - in_review
            - approved
            - declined
        sessionId:
          type:
            - string
            - 'null'
          description: Active verification session id, if any.
        sessionUrl:
          type:
            - string
            - 'null'
          description: URL where the merchant completes verification, if any.
        submittedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When verification was first submitted.
        verifiedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the status became approved.
        declinedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the status became declined.
    Envelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              description: Operation-specific payload (object, array, or null).
  responses:
    Unauthorized:
      description: Missing or invalid app access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 401
            success: false
            message: Authentication required
            data: null
    Forbidden:
      description: The app token is missing the OAuth scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 403
            success: false
            message: Insufficient scope
            data: null
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side — never send a shop
        id.

````