> ## 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.

# initiateCompanyKyb

> The `initiateCompanyKyb` API is used to begin the required business verification for regulatory compliance. This triggers the KYB (Know Your Business) process to verify business information with official records.

### What it does:

- Initiates the formal KYB verification process for the company
- Validates submitted company information against official records

### Prerequisites:

Before initiating KYB, the following steps must be completed:

1. **Company Registration**: Basic company profile must be established

2. **Company Location**: Primary physical location must be added

3. **Business User**: Admin user details must be updated with required information. At least one admin user must be a Beneficial Owner with at least 25% share of the company

4. **KYB Information**: Essential business data (EIN, entity type, incorporation date) must be submitted

### Note:

- This step is mandatory for regulatory compliance and must be completed before the company can access full payroll functionality and process payments.
- If Kyb fails please correct the record using the `updateKybInformation` API and re-initiate



## OpenAPI

````yaml post /companyOnboarding/initiateCompanyKyb
openapi: 3.0.1
info:
  title: Default module
  description: ''
  version: 1.0.0
servers: []
security:
  - basic: []
tags: []
paths:
  /companyOnboarding/initiateCompanyKyb:
    post:
      tags: []
      summary: initiateCompanyKyb
      description: >-
        The `initiateCompanyKyb` API is used to begin the required business
        verification for regulatory compliance. This triggers the KYB (Know Your
        Business) process to verify business information with official records.


        ### What it does:


        - Initiates the formal KYB verification process for the company

        - Validates submitted company information against official records


        ### Prerequisites:


        Before initiating KYB, the following steps must be completed:


        1. **Company Registration**: Basic company profile must be established


        2. **Company Location**: Primary physical location must be added


        3. **Business User**: Admin user details must be updated with required
        information. At least one admin user must be a Beneficial Owner with at
        least 25% share of the company


        4. **KYB Information**: Essential business data (EIN, entity type,
        incorporation date) must be submitted


        ### Note:


        - This step is mandatory for regulatory compliance and must be completed
        before the company can access full payroll functionality and process
        payments.

        - If Kyb fails please correct the record using the
        `updateKybInformation` API and re-initiate
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                  title: initiateCompanyKyb
                  example: initiateCompanyKyb
                companyId:
                  type: string
                  format: uuid
              required:
                - method
                - companyId
            example:
              method: initiateCompanyKyb
              companyId: 8A9B7683-8E02-494D-8422-963FD05EE785
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  initiateKyb:
                    type: object
                    properties:
                      companyId:
                        type: string
                      status:
                        type: string
                      message:
                        type: string
                    required:
                      - companyId
                      - status
                required:
                  - initiateKyb
              example:
                initiateKyb:
                  companyId: 0A455F56-8B75-4834-B6A7-13A0F86315DE
                  status: KYB Verification Initiated
                  message: The KYB Initiated for KYB test successfully.
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
              example:
                error:
                  code: 400
                  message: Invalid Company ID. Company not found.
          headers: {}
      deprecated: false
      security:
        - basic: []
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic

````