initiateCompanyKyb

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/companyOnboarding#initiateCompanyKyb' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "initiateCompanyKyb",
  "companyId": "8A9B7683-8E02-494D-8422-963FD05EE785"
}
'

{
  "initiateKyb": {
    "companyId": "0A455F56-8B75-4834-B6A7-13A0F86315DE",
    "status": "KYB Verification Initiated",
    "message": "The KYB Initiated for KYB test successfully."
  }
}

Company Onboarding

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:

Company Registration: Basic company profile must be established
Company Location: Primary physical location must be added
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
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.

POST

companyOnboarding#initiateCompanyKyb

initiateCompanyKyb

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/companyOnboarding#initiateCompanyKyb' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "initiateCompanyKyb",
  "companyId": "8A9B7683-8E02-494D-8422-963FD05EE785"
}
'

{
  "initiateKyb": {
    "companyId": "0A455F56-8B75-4834-B6A7-13A0F86315DE",
    "status": "KYB Verification Initiated",
    "message": "The KYB Initiated for KYB test successfully."
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

required

Example:

"initiateCompanyKyb"

companyId

string<uuid>

required

Response

initiateKyb

object

required

Show child attributes

addKybInformation addBusinessUser