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

# Simulate company status

> Simulates a company status change. `ACTIVE` completes the company onboarding. `REJECTED` simulates a declined KYB verification. `IN_REVIEW` simulates a pending KYB review.



## OpenAPI

````yaml /api-reference/openapi.json post /simulation/companies/{companyId}/status
openapi: 3.1.0
info:
  title: Reap API
  version: 1.0.0
  description: Reap platform API
servers:
  - url: https://sandbox.api.reap.global
    description: Sandbox
  - url: https://prod.api.reap.global
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Accounts
  - name: Activities
  - name: Card Designs
  - name: Card Shipments
  - name: Card Transactions
  - name: Cards
  - name: Companies
  - name: Crypto Deposits
  - name: Policies
  - name: Simulation
  - name: Users
  - name: Virtual Asset Postings
  - name: Virtual Assets
  - name: Webhooks
paths:
  /simulation/companies/{companyId}/status:
    post:
      tags:
        - Simulation
      summary: Simulate company status
      description: >-
        Simulates a company status change. `ACTIVE` completes the company
        onboarding. `REJECTED` simulates a declined KYB verification.
        `IN_REVIEW` simulates a pending KYB review.
      operationId: companyStatus_simulation
      parameters:
        - name: companyId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Reap-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2025-02-14'
            description: API version (YYYY-MM-DD)
            example: '2025-02-14'
      requestBody:
        description: >-
          Simulate a company status change. `ACTIVE` requires
          `applicationDetails` so the simulated company matches the shape of one
          verified through AiPrise.
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    status:
                      type: string
                      const: ACTIVE
                    applicationDetails:
                      type: object
                      properties:
                        legalEntityName:
                          type: string
                          minLength: 1
                          maxLength: 255
                          description: >-
                            The legal entity's full name as verified at KYB.
                            Used as both `fullName` and `businessName` when
                            issuing Business cards.
                        registrationNumber:
                          type: string
                          minLength: 1
                          maxLength: 100
                          description: The legal entity's business registration number.
                        country:
                          description: >-
                            ISO 3166-1 alpha-2 code of the legal entity's
                            country of registration.
                          type: string
                          minLength: 2
                          maxLength: 2
                          examples:
                            - US
                            - GB
                            - DE
                        registeredAddress:
                          anyOf:
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                state:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - city
                                - country
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  anyOf:
                                    - type: string
                                      minLength: 1
                                      maxLength: 255
                                    - type: 'null'
                                state:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - state
                                - country
                          description: Registered (legal) address.
                        operationalAddress:
                          anyOf:
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                state:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - city
                                - country
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  anyOf:
                                    - type: string
                                      minLength: 1
                                      maxLength: 255
                                    - type: 'null'
                                state:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - state
                                - country
                          description: Address where the business operates day-to-day.
                      required:
                        - legalEntityName
                        - registrationNumber
                        - country
                        - registeredAddress
                        - operationalAddress
                      description: >-
                        Verified KYB attributes to persist alongside the status
                        change.
                  required:
                    - status
                    - applicationDetails
                  title: Active
                - type: object
                  properties:
                    status:
                      type: string
                      const: REJECTED
                  required:
                    - status
                  title: Rejected
                - type: object
                  properties:
                    status:
                      type: string
                      const: IN_REVIEW
                  required:
                    - status
                  title: InReview
          application/x-www-form-urlencoded:
            schema:
              oneOf:
                - type: object
                  properties:
                    status:
                      type: string
                      const: ACTIVE
                    applicationDetails:
                      type: object
                      properties:
                        legalEntityName:
                          type: string
                          minLength: 1
                          maxLength: 255
                          description: >-
                            The legal entity's full name as verified at KYB.
                            Used as both `fullName` and `businessName` when
                            issuing Business cards.
                        registrationNumber:
                          type: string
                          minLength: 1
                          maxLength: 100
                          description: The legal entity's business registration number.
                        country:
                          description: >-
                            ISO 3166-1 alpha-2 code of the legal entity's
                            country of registration.
                          type: string
                          minLength: 2
                          maxLength: 2
                          examples:
                            - US
                            - GB
                            - DE
                        registeredAddress:
                          anyOf:
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                state:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - city
                                - country
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  anyOf:
                                    - type: string
                                      minLength: 1
                                      maxLength: 255
                                    - type: 'null'
                                state:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - state
                                - country
                          description: Registered (legal) address.
                        operationalAddress:
                          anyOf:
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                state:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - city
                                - country
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  anyOf:
                                    - type: string
                                      minLength: 1
                                      maxLength: 255
                                    - type: 'null'
                                state:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - state
                                - country
                          description: Address where the business operates day-to-day.
                      required:
                        - legalEntityName
                        - registrationNumber
                        - country
                        - registeredAddress
                        - operationalAddress
                      description: >-
                        Verified KYB attributes to persist alongside the status
                        change.
                  required:
                    - status
                    - applicationDetails
                  title: Active
                - type: object
                  properties:
                    status:
                      type: string
                      const: REJECTED
                  required:
                    - status
                  title: Rejected
                - type: object
                  properties:
                    status:
                      type: string
                      const: IN_REVIEW
                  required:
                    - status
                  title: InReview
          multipart/form-data:
            schema:
              oneOf:
                - type: object
                  properties:
                    status:
                      type: string
                      const: ACTIVE
                    applicationDetails:
                      type: object
                      properties:
                        legalEntityName:
                          type: string
                          minLength: 1
                          maxLength: 255
                          description: >-
                            The legal entity's full name as verified at KYB.
                            Used as both `fullName` and `businessName` when
                            issuing Business cards.
                        registrationNumber:
                          type: string
                          minLength: 1
                          maxLength: 100
                          description: The legal entity's business registration number.
                        country:
                          description: >-
                            ISO 3166-1 alpha-2 code of the legal entity's
                            country of registration.
                          type: string
                          minLength: 2
                          maxLength: 2
                          examples:
                            - US
                            - GB
                            - DE
                        registeredAddress:
                          anyOf:
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                state:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - city
                                - country
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  anyOf:
                                    - type: string
                                      minLength: 1
                                      maxLength: 255
                                    - type: 'null'
                                state:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - state
                                - country
                          description: Registered (legal) address.
                        operationalAddress:
                          anyOf:
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                state:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - city
                                - country
                            - type: object
                              properties:
                                line1:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                line2:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                city:
                                  anyOf:
                                    - type: string
                                      minLength: 1
                                      maxLength: 255
                                    - type: 'null'
                                state:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                postalCode:
                                  anyOf:
                                    - type: string
                                      maxLength: 255
                                    - type: 'null'
                                country:
                                  type: string
                                  minLength: 2
                                  maxLength: 2
                                  examples:
                                    - US
                                    - GB
                                    - DE
                                  description: ISO 3166-1 alpha-2 country code
                              required:
                                - line1
                                - line2
                                - state
                                - country
                          description: Address where the business operates day-to-day.
                      required:
                        - legalEntityName
                        - registrationNumber
                        - country
                        - registeredAddress
                        - operationalAddress
                      description: >-
                        Verified KYB attributes to persist alongside the status
                        change.
                  required:
                    - status
                    - applicationDetails
                  title: Active
                - type: object
                  properties:
                    status:
                      type: string
                      const: REJECTED
                  required:
                    - status
                  title: Rejected
                - type: object
                  properties:
                    status:
                      type: string
                      const: IN_REVIEW
                  required:
                    - status
                  title: InReview
      responses:
        '204':
          description: Response for status 204
        '400':
          description: The resource is not in a valid state for the requested simulation
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: SIMULATION_INVALID_STATE
                      message:
                        type: string
                      detail:
                        anyOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                    required:
                      - code
                      - message
                      - detail
                required:
                  - error
                title: SimulationInvalidStateError
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: COMPANY_NOT_FOUND
                      message:
                        type: string
                      detail:
                        anyOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                    required:
                      - code
                      - message
                      - detail
                required:
                  - error
                title: CompanyNotFoundError
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token

````