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

# refreshCompanyKybStatus

> ⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in production flows

### Required inputs:
- `companyId`: The ID of the test company.

### Response:
The company KYB result uses the field `kycStatus`. Check that `success` is `true` and `kycStatus` is `passed` before continuing with workflows that require verified company information. A completed request does not guarantee approval.

### Notes:
- Status refreshes do not bypass verification requirements. If the status has not passed, check the returned message, allow processing time and try again if the status does not update first time.
- If the status will still not update after a while, please rwach out to support for further investigation



## OpenAPI

````yaml POST /sandbox/refreshCompanyKybStatus
openapi: 3.1.0
info:
  title: Default module
  description: |
    Webhook events emitted when a company's KYB status is created or changes.

    Rollfi sends these requests to the webhook URL configured for the client.
    Consumers should return a successful 2xx response after accepting the event.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Admin Portal
  - name: TimeOff Admin
  - name: TimeTracking Admin
  - name: TimeOff User
  - name: TimeTracking User
  - name: TimeTracking Reports
  - name: TimeOff Reports
  - name: Pay Schedule Webhooks
  - name: Pay Period Webhooks
  - name: Employee Bank Account Webhooks
  - name: Employee KYC Webhooks
  - name: Company Bank Account Webhooks
  - name: Company Webhooks
  - name: Employee Status Webhooks
  - name: Sandbox
paths:
  /sandbox/refreshCompanyKybStatus:
    post:
      tags:
        - Sandbox
      summary: refreshCompanyKybStatus
      description: >-
        ⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in
        production flows


        ### Required inputs:

        - `companyId`: The ID of the test company.


        ### Response:

        The company KYB result uses the field `kycStatus`. Check that `success`
        is `true` and `kycStatus` is `passed` before continuing with workflows
        that require verified company information. A completed request does not
        guarantee approval.


        ### Notes:

        - Status refreshes do not bypass verification requirements. If the
        status has not passed, check the returned message, allow processing time
        and try again if the status does not update first time.

        - If the status will still not update after a while, please rwach out to
        support for further investigation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                  default: refreshCompanyKybStatus
                companyId:
                  type: string
                  format: uuid
                  description: The ID of the sandbox company.
              required:
                - method
                - companyId
            example:
              method: refreshCompanyKybStatus
              companyId: 8b2f4a91-6c35-4d7e-9a10-2f83c5e6b074
      responses:
        '200':
          description: >-
            The current verification result or an error response. Check the
            response body rather than relying on the HTTP status alone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  kycStatus:
                    type: string
                    description: >-
                      The company's KYB status. A value of passed indicates
                      successful verification.
                  message:
                    type: string
                  error:
                    type:
                      - object
                      - string
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
              examples:
                '1':
                  summary: Success
                  value:
                    success: true
                    kycStatus: passed
                    message: Company kyb status is passed.
          headers: {}
      deprecated: false
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.