addBusinessUser
curl --request POST \
--url https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addBusinessUser",
"businessUser": {
"companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
"firstName": "Tim",
"middleName": "",
"lastName": "David",
"phoneNumber": "9889890989",
"email": "tim@david.xyz",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"payrollAdmin": true,
"bookKeeper": true,
"beneficialOwner": true,
"ownershipPercentage": 25
}
}
'import requests
url = "https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser"
payload = {
"method": "addBusinessUser",
"businessUser": {
"companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
"firstName": "Tim",
"middleName": "",
"lastName": "David",
"phoneNumber": "9889890989",
"email": "tim@david.xyz",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"payrollAdmin": True,
"bookKeeper": True,
"beneficialOwner": True,
"ownershipPercentage": 25
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'addBusinessUser',
businessUser: {
companyId: '8A9B7683-8E02-494D-8422-963FD05EE785',
firstName: 'Tim',
middleName: '',
lastName: 'David',
phoneNumber: '9889890989',
email: 'tim@david.xyz',
address1: '8745 Colard Ln',
address2: '',
city: 'Lyons',
state: 'CO',
zipcode: '80540',
ssn: '123098989',
dateOfBirth: '2000-09-09',
payrollAdmin: true,
bookKeeper: true,
beneficialOwner: true,
ownershipPercentage: 25
}
})
};
fetch('https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'addBusinessUser',
'businessUser' => [
'companyId' => '8A9B7683-8E02-494D-8422-963FD05EE785',
'firstName' => 'Tim',
'middleName' => '',
'lastName' => 'David',
'phoneNumber' => '9889890989',
'email' => 'tim@david.xyz',
'address1' => '8745 Colard Ln',
'address2' => '',
'city' => 'Lyons',
'state' => 'CO',
'zipcode' => '80540',
'ssn' => '123098989',
'dateOfBirth' => '2000-09-09',
'payrollAdmin' => true,
'bookKeeper' => true,
'beneficialOwner' => true,
'ownershipPercentage' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser"
payload := strings.NewReader("{\n \"method\": \"addBusinessUser\",\n \"businessUser\": {\n \"companyId\": \"8A9B7683-8E02-494D-8422-963FD05EE785\",\n \"firstName\": \"Tim\",\n \"middleName\": \"\",\n \"lastName\": \"David\",\n \"phoneNumber\": \"9889890989\",\n \"email\": \"tim@david.xyz\",\n \"address1\": \"8745 Colard Ln\",\n \"address2\": \"\",\n \"city\": \"Lyons\",\n \"state\": \"CO\",\n \"zipcode\": \"80540\",\n \"ssn\": \"123098989\",\n \"dateOfBirth\": \"2000-09-09\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 25\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addBusinessUser\",\n \"businessUser\": {\n \"companyId\": \"8A9B7683-8E02-494D-8422-963FD05EE785\",\n \"firstName\": \"Tim\",\n \"middleName\": \"\",\n \"lastName\": \"David\",\n \"phoneNumber\": \"9889890989\",\n \"email\": \"tim@david.xyz\",\n \"address1\": \"8745 Colard Ln\",\n \"address2\": \"\",\n \"city\": \"Lyons\",\n \"state\": \"CO\",\n \"zipcode\": \"80540\",\n \"ssn\": \"123098989\",\n \"dateOfBirth\": \"2000-09-09\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"addBusinessUser\",\n \"businessUser\": {\n \"companyId\": \"8A9B7683-8E02-494D-8422-963FD05EE785\",\n \"firstName\": \"Tim\",\n \"middleName\": \"\",\n \"lastName\": \"David\",\n \"phoneNumber\": \"9889890989\",\n \"email\": \"tim@david.xyz\",\n \"address1\": \"8745 Colard Ln\",\n \"address2\": \"\",\n \"city\": \"Lyons\",\n \"state\": \"CO\",\n \"zipcode\": \"80540\",\n \"ssn\": \"123098989\",\n \"dateOfBirth\": \"2000-09-09\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"businessUser": {
"businessUserId": "5370FF7F-9FFF-401A-A949-AFB393B50F09",
"status": "KYC Pending",
"message": "Tim David has been successfully added as BusinessUser."
}
}Company Onboarding
addBusinessUser
The addBusinessUser API is used to create a Business User and define their permissions and responsibilities within the system.
What it does:
- Creates a Business User with defined roles and permissions
- Establishes user access levels based on assigned roles providing role-based functionality
- Supports multiple role assignments for flexible user management
Business User Roles:
A Business User can have one or more of these roles:
| Role | Description |
|---|---|
| Payroll Admin | Full access to payroll processing and management functions |
| Beneficial Owner | Legal ownership stake in the company (At least 25% share must be stated) |
| Book Keeper | Usually limited access to read-only for company accounting purposes and reporting |
Notes:
- At least one beneficial owner with at least 25% share of the company must be registered to the system for compliance. A sole beneficial owner cannot be deleted before another is added.
- For beneficial owners dateOfBirth, address1, address2, city, state, zipcode, ssn and ownershipPercentage are mandatory for compliance purposes.
POST
/
companyOnboarding
/
addBusinessUser
addBusinessUser
curl --request POST \
--url https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addBusinessUser",
"businessUser": {
"companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
"firstName": "Tim",
"middleName": "",
"lastName": "David",
"phoneNumber": "9889890989",
"email": "tim@david.xyz",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"payrollAdmin": true,
"bookKeeper": true,
"beneficialOwner": true,
"ownershipPercentage": 25
}
}
'import requests
url = "https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser"
payload = {
"method": "addBusinessUser",
"businessUser": {
"companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
"firstName": "Tim",
"middleName": "",
"lastName": "David",
"phoneNumber": "9889890989",
"email": "tim@david.xyz",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"payrollAdmin": True,
"bookKeeper": True,
"beneficialOwner": True,
"ownershipPercentage": 25
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'addBusinessUser',
businessUser: {
companyId: '8A9B7683-8E02-494D-8422-963FD05EE785',
firstName: 'Tim',
middleName: '',
lastName: 'David',
phoneNumber: '9889890989',
email: 'tim@david.xyz',
address1: '8745 Colard Ln',
address2: '',
city: 'Lyons',
state: 'CO',
zipcode: '80540',
ssn: '123098989',
dateOfBirth: '2000-09-09',
payrollAdmin: true,
bookKeeper: true,
beneficialOwner: true,
ownershipPercentage: 25
}
})
};
fetch('https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'addBusinessUser',
'businessUser' => [
'companyId' => '8A9B7683-8E02-494D-8422-963FD05EE785',
'firstName' => 'Tim',
'middleName' => '',
'lastName' => 'David',
'phoneNumber' => '9889890989',
'email' => 'tim@david.xyz',
'address1' => '8745 Colard Ln',
'address2' => '',
'city' => 'Lyons',
'state' => 'CO',
'zipcode' => '80540',
'ssn' => '123098989',
'dateOfBirth' => '2000-09-09',
'payrollAdmin' => true,
'bookKeeper' => true,
'beneficialOwner' => true,
'ownershipPercentage' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser"
payload := strings.NewReader("{\n \"method\": \"addBusinessUser\",\n \"businessUser\": {\n \"companyId\": \"8A9B7683-8E02-494D-8422-963FD05EE785\",\n \"firstName\": \"Tim\",\n \"middleName\": \"\",\n \"lastName\": \"David\",\n \"phoneNumber\": \"9889890989\",\n \"email\": \"tim@david.xyz\",\n \"address1\": \"8745 Colard Ln\",\n \"address2\": \"\",\n \"city\": \"Lyons\",\n \"state\": \"CO\",\n \"zipcode\": \"80540\",\n \"ssn\": \"123098989\",\n \"dateOfBirth\": \"2000-09-09\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 25\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addBusinessUser\",\n \"businessUser\": {\n \"companyId\": \"8A9B7683-8E02-494D-8422-963FD05EE785\",\n \"firstName\": \"Tim\",\n \"middleName\": \"\",\n \"lastName\": \"David\",\n \"phoneNumber\": \"9889890989\",\n \"email\": \"tim@david.xyz\",\n \"address1\": \"8745 Colard Ln\",\n \"address2\": \"\",\n \"city\": \"Lyons\",\n \"state\": \"CO\",\n \"zipcode\": \"80540\",\n \"ssn\": \"123098989\",\n \"dateOfBirth\": \"2000-09-09\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/companyOnboarding/addBusinessUser")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"addBusinessUser\",\n \"businessUser\": {\n \"companyId\": \"8A9B7683-8E02-494D-8422-963FD05EE785\",\n \"firstName\": \"Tim\",\n \"middleName\": \"\",\n \"lastName\": \"David\",\n \"phoneNumber\": \"9889890989\",\n \"email\": \"tim@david.xyz\",\n \"address1\": \"8745 Colard Ln\",\n \"address2\": \"\",\n \"city\": \"Lyons\",\n \"state\": \"CO\",\n \"zipcode\": \"80540\",\n \"ssn\": \"123098989\",\n \"dateOfBirth\": \"2000-09-09\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"businessUser": {
"businessUserId": "5370FF7F-9FFF-401A-A949-AFB393B50F09",
"status": "KYC Pending",
"message": "Tim David has been successfully added as BusinessUser."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Show child attributes
Show child attributes
⌘I