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

# Simulate KYB status

> Sets a test account's KYB status outside production so you can exercise onboarding-gated workflows in staging.



## OpenAPI

````yaml /openapi/openapi.json post /simulate/kyb/status
openapi: 3.1.0
info:
  title: Stabyl API
  description: >-
    REST API for approved Stabyl accounts to automate exchange, wallet, and
    non-production simulation workflows.
  contact:
    name: Stabyl Support
    email: support@stabyl.com
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.stabyl.com/v1
    description: Production
  - url: https://api-staging.stabyl.com/v1
    description: Staging
security: []
tags:
  - name: Exchange
    description: Trading market data and order management for account automation.
  - name: Wallets
    description: >-
      Supported routes, deposit destinations, balances, transactions, and saved
      recipients.
  - name: Webhooks
    description: >-
      Outbound event delivery configuration and eventually consistent delivery
      history. Verify Standard Webhooks webhook-id, webhook-timestamp, and
      webhook-signature headers against the unchanged raw request body before
      parsing JSON.
  - name: Simulation
    description: Non-production endpoints for testing integration behavior.
paths:
  /simulate/kyb/status:
    post:
      tags:
        - Simulation
      summary: Simulate KYB status
      description: >-
        Sets a test account's KYB status outside production so you can exercise
        onboarding-gated workflows in staging.
      operationId: post_simulate_kyb_status
      requestBody:
        description: Non-production KYB state to apply to a test account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateKybStatusRequest'
        required: true
      responses:
        '200':
          description: Simulated KYB status updated
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/SimulateKybStatusResponse'
                  status:
                    type: string
                    enum:
                      - success
              example:
                data:
                  decision: approved
                  status: approved
                  user_id: 0197f1f0-0000-7000-8000-000000000006
                status: success
        '400':
          description: Invalid payload
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: VALIDATION_FAILED
                      message:
                        type: string
                        example: invalid request parameters
                  status:
                    type: string
                    enum:
                      - error
              example:
                error:
                  code: VALIDATION_FAILED
                  message: invalid request parameters
                status: error
        '403':
          description: Simulate API disabled in production
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: FORBIDDEN
                      message:
                        type: string
                        example: request is not allowed
                  status:
                    type: string
                    enum:
                      - error
              example:
                error:
                  code: FORBIDDEN
                  message: request is not allowed
                status: error
        '404':
          description: User not found
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: NOT_FOUND
                      message:
                        type: string
                        example: resource not found
                  status:
                    type: string
                    enum:
                      - error
              example:
                error:
                  code: NOT_FOUND
                  message: resource not found
                status: error
      security: []
components:
  schemas:
    SimulateKybStatusRequest:
      type: object
      description: Non-production KYB state change for a test account.
      required:
        - user_id
        - status
      properties:
        status:
          $ref: '#/components/schemas/SimulateKybStatus'
        user_id:
          type: string
          format: uuid
    SimulateKybStatusResponse:
      type: object
      description: Result returned after applying a non-production KYB state.
      required:
        - user_id
        - status
        - decision
      properties:
        decision:
          $ref: '#/components/schemas/SimulateKybDecision'
        status:
          $ref: '#/components/schemas/SimulateKybStatus'
        user_id:
          type: string
          format: uuid
    SimulateKybStatus:
      type: string
      description: KYB status value to apply in a non-production simulation.
      enum:
        - approved
        - rejected
        - pending
    SimulateKybDecision:
      type: string
      description: Decision value to apply in a non-production KYB simulation.
      enum:
        - approved
        - denied
        - unknown

````