Company Onboarding
createBusiness
- Documentation
- API Reference
Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
Reports
API Reference
Company Onboarding
createBusiness
The createBusiness API offers a holistic solution for seamlessly integrating a new company into the system. This API is designed to streamline the onboarding process by consolidating multiple steps into a single, efficient call. This approach is ideal for businesses seeking a quick and straightforward onboarding experience.
Features of createBusiness API:
-
Company Registration
-
KYB Information
-
Location Setup
-
Admin User Addition:
-
KYB Process Initiation
About NAICS Codes:
- NAICS codes are a numerical system with a range from two to six digits.
- These codes are used for various administrative, regulatory, contracting, taxation, and business development purposes.
POST
/
companyOnboarding#createBusiness
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
username
string
username
string
password
string
password
string
object
method
createBusiness · string
*
method
Required
string
Add Example Value
registration
object
*
registration
Required
object
company
string
*
company
Required
string
businessWebsite
string
*
businessWebsite
Required
string
nacisSubCategoryCode
Refer link in description · integer
nacisSubCategoryCode
integer
isEsign
boolean
*
isEsign
Required
boolean
isTermsAccepted
boolean
*
isTermsAccepted
Required
boolean
kybInformation
object
*
kybInformation
Required
object
ein
Must be 9 Digits · string
*
ein
Required
string
Add Example Value
entityType
Enum · enum<string>
*
entityType
Required
enum<string>
dateOfIncorporation
string
*
dateOfIncorporation
Required
string
Add Example Value
companyLocation
object
*
companyLocation
Required
object
companyLocation
Enum · string
*
companyLocation
Required
string
Add Example Value
address1
string
*
address1
Required
string
address2
string
address2
string
city
string
*
city
Required
string
state
Enum · enum<string>
*
state
Required
enum<string>
zipcode
Must be Five or Nine Digits · string
*
zipcode
Required
string
country
Currently only US is supported · enum<string>
*
country
Required
enum<string>
phoneNumber
Must be 10 digits · string
*
phoneNumber
Required
string
Add Example Value
isWorkLocation
boolean
*
isWorkLocation
Required
boolean
isMailingAddress
boolean
*
isMailingAddress
Required
boolean
isFilingAddress
boolean
*
isFilingAddress
Required
boolean
businessUser
object
*
businessUser
Required
object
firstName
string
*
firstName
Required
string
middleName
string
middleName
string
lastName
string
*
lastName
Required
string
phoneNumber
Must be 10 digits · string
*
phoneNumber
Required
string
Add Example Value
email
string
*
email
Required
string
address1
string
*
address1
Required
string
address2
string
address2
string
city
string
*
city
Required
string
state
Enum · enum<string>
*
state
Required
enum<string>
zipcode
string
*
zipcode
Required
string
country
Currently only US is supported · enum<string>
*
country
Required
enum<string>
ssn
Must be 9 Digits · string
*
ssn
Required
string
Add Example Value
dateOfBirth
string
*
dateOfBirth
Required
string
isPayrollAdmin
boolean
*
isPayrollAdmin
Required
boolean
isController
boolean
*
isController
Required
boolean
isBeneficialOwner
boolean
*
isBeneficialOwner
Required
boolean
ownershipPercentage
Must be specified for Beneficial Owner · number
ownershipPercentage
number
curl --request POST \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#createBusiness' \
--header 'Content-Type: application/json' \
--data '{
"method": "createBusiness",
"registration": {
"company": "Wise Wonders co",
"businessWebsite": "www.Wonders.com",
"nacisSubCategoryCode": 6233,
"isEsign": true,
"isTermsAccepted": true
},
"kybInformation": {
"ein": "897999712",
"entityType": "LLP",
"dateOfIncorporation": "2023-02-25"
},
"companyLocation": {
"companyLocation": "Main",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"phoneNumber": "9889890989",
"isWorkLocation": true,
"isMailingAddress": true,
"isFilingAddress": true
},
"businessUser": {
"firstName": "Jason",
"middleName": "",
"lastName": "Roy",
"phoneNumber": "9974574177",
"email": "jaso8nroyee758@mailsac.com",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"isPayrollAdmin": true,
"isController": true,
"isBeneficialOwner": true,
"ownershipPercentage": 25
}
}'{
"1": {
"summary": "Success",
"value": {
"registration": {
"companyId": "98016CB2-FAA4-47E5-8173-DD6F29C7C397",
"kybInformationId": "32E9AE44-529A-4B4E-9C40-56DFCE99E712",
"businessUserId": "4B47C1DA-F279-40E8-ABF6-ADD82E7C2582",
"companyLocationId": "FB3B168C-62C2-43D0-A1EF-B3C6C5C6FAE3",
"status": "Registered",
"message": "A company with name Wise Wonders co is registered successfully and KYB verification is in progress."
}
}
}
}Body
application/json
method
string
default: createBusinessrequiredregistration
object
requiredregistration.company
string
requiredregistration.businessWebsite
string
requiredregistration.nacisSubCategoryCode
integer
registration.isEsign
boolean
requiredregistration.isTermsAccepted
boolean
requiredkybInformation
object
requiredkybInformation.ein
string
requiredkybInformation.entityType
enum<string>
requiredAvailable options:
LP, Corporation, Unincorporated Association, LLP, LLC, Non-Profit, Partnership, Trust, sole_proprietorship kybInformation.dateOfIncorporation
string
requiredcompanyLocation
object
requiredcompanyLocation.companyLocation
string
requiredcompanyLocation.address1
string
requiredcompanyLocation.address2
string
companyLocation.city
string
requiredcompanyLocation.state
enum<string>
requiredAvailable options:
TX, AK, ND, IL, MA, KS, AS, AL, UT, SD, MI, DC, GA, SC, TN, OK, CO, CA, ME, MO, WY, MD, VT, NM, CT, AZ, WI, VA, WV, NJ, DE, NC, PR, IN, MT, NH, HI, IA, KY, WA, OH, FL, OR, MP, GU, MN, MS, PA, NE, RI, ID, LA, NY, NV, AR companyLocation.zipcode
string
requiredcompanyLocation.country
enum<string>
requiredAvailable options:
US companyLocation.phoneNumber
string
requiredcompanyLocation.isWorkLocation
boolean
requiredcompanyLocation.isMailingAddress
boolean
requiredcompanyLocation.isFilingAddress
boolean
requiredbusinessUser
object
requiredbusinessUser.firstName
string
requiredbusinessUser.middleName
string
businessUser.lastName
string
requiredbusinessUser.phoneNumber
string
requiredbusinessUser.email
string
requiredbusinessUser.address1
string
requiredbusinessUser.address2
string
businessUser.city
string
requiredbusinessUser.state
enum<string>
requiredAvailable options:
TX, AK, ND, IL, MA, KS, AS, AL, UT, SD, MI, DC, GA, SC, TN, OK, CO, CA, ME, MO, WY, MD, VT, NM, CT, AZ, WI, VA, WV, NJ, DE, NC, PR, IN, MT, NH, HI, IA, KY, WA, OH, FL, OR, MP, GU, MN, MS, PA, NE, RI, ID, LA, NY, NV, AR businessUser.zipcode
string
requiredbusinessUser.country
enum<string>
requiredAvailable options:
US businessUser.ssn
string
requiredbusinessUser.dateOfBirth
string
requiredbusinessUser.isPayrollAdmin
boolean
requiredbusinessUser.isController
boolean
requiredbusinessUser.isBeneficialOwner
boolean
requiredbusinessUser.ownershipPercentage
number
Response
200 - application/json
registration
object
requiredregistration.companyId
string
requiredregistration.kybInformationId
string
requiredregistration.businessUserId
string
requiredregistration.companyLocationId
string
requiredregistration.status
string
registration.message
string
curl --request POST \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#createBusiness' \
--header 'Content-Type: application/json' \
--data '{
"method": "createBusiness",
"registration": {
"company": "Wise Wonders co",
"businessWebsite": "www.Wonders.com",
"nacisSubCategoryCode": 6233,
"isEsign": true,
"isTermsAccepted": true
},
"kybInformation": {
"ein": "897999712",
"entityType": "LLP",
"dateOfIncorporation": "2023-02-25"
},
"companyLocation": {
"companyLocation": "Main",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"phoneNumber": "9889890989",
"isWorkLocation": true,
"isMailingAddress": true,
"isFilingAddress": true
},
"businessUser": {
"firstName": "Jason",
"middleName": "",
"lastName": "Roy",
"phoneNumber": "9974574177",
"email": "jaso8nroyee758@mailsac.com",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"isPayrollAdmin": true,
"isController": true,
"isBeneficialOwner": true,
"ownershipPercentage": 25
}
}'{
"1": {
"summary": "Success",
"value": {
"registration": {
"companyId": "98016CB2-FAA4-47E5-8173-DD6F29C7C397",
"kybInformationId": "32E9AE44-529A-4B4E-9C40-56DFCE99E712",
"businessUserId": "4B47C1DA-F279-40E8-ABF6-ADD82E7C2582",
"companyLocationId": "FB3B168C-62C2-43D0-A1EF-B3C6C5C6FAE3",
"status": "Registered",
"message": "A company with name Wise Wonders co is registered successfully and KYB verification is in progress."
}
}
}
}