addStateW4Information
curl --request POST \
--url https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addStateW4Information",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateW4Information": {
"Filing Status": "Married",
"Withholding Allowance": "10",
"Additional Withholding": "10.10",
"NYC Withholding Allowance": "20",
"NYC Additional Withholding": "14.00"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information"
payload = {
"method": "addStateW4Information",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateW4Information": {
"Filing Status": "Married",
"Withholding Allowance": "10",
"Additional Withholding": "10.10",
"NYC Withholding Allowance": "20",
"NYC Additional Withholding": "14.00"
}
}
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: 'addStateW4Information',
userId: 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
stateW4Information: {
'Filing Status': 'Married',
'Withholding Allowance': '10',
'Additional Withholding': '10.10',
'NYC Withholding Allowance': '20',
'NYC Additional Withholding': '14.00'
}
})
};
fetch('https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information', 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/userOnboarding/addStateW4Information",
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' => 'addStateW4Information',
'userId' => 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
'stateW4Information' => [
'Filing Status' => 'Married',
'Withholding Allowance' => '10',
'Additional Withholding' => '10.10',
'NYC Withholding Allowance' => '20',
'NYC Additional Withholding' => '14.00'
]
]),
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/userOnboarding/addStateW4Information"
payload := strings.NewReader("{\n \"method\": \"addStateW4Information\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateW4Information\": {\n \"Filing Status\": \"Married\",\n \"Withholding Allowance\": \"10\",\n \"Additional Withholding\": \"10.10\",\n \"NYC Withholding Allowance\": \"20\",\n \"NYC Additional Withholding\": \"14.00\"\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/userOnboarding/addStateW4Information")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addStateW4Information\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateW4Information\": {\n \"Filing Status\": \"Married\",\n \"Withholding Allowance\": \"10\",\n \"Additional Withholding\": \"10.10\",\n \"NYC Withholding Allowance\": \"20\",\n \"NYC Additional Withholding\": \"14.00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information")
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\": \"addStateW4Information\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateW4Information\": {\n \"Filing Status\": \"Married\",\n \"Withholding Allowance\": \"10\",\n \"Additional Withholding\": \"10.10\",\n \"NYC Withholding Allowance\": \"20\",\n \"NYC Additional Withholding\": \"14.00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"stateW4Information": {
"status": "Ready",
"message": "The StateW4Information for Steve Jobs has been saved successfully."
}
}User Onboarding
addStateW4Information
The addStateW4Information API is used to collect state-specific tax withholding information for employees in states that require additional withholding forms.
To retreive the state specific W4 fields use ‘getStateW4FormFields` with the userId
What it does:
- Collects state-specific withholding data
- Ensures compliance with state tax regulations
Note:
- This step is only required for employees in states with their own W-4 forms. Skip this step if the employee’s state doesn’t require additional withholding information.
POST
/
userOnboarding
/
addStateW4Information
addStateW4Information
curl --request POST \
--url https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addStateW4Information",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateW4Information": {
"Filing Status": "Married",
"Withholding Allowance": "10",
"Additional Withholding": "10.10",
"NYC Withholding Allowance": "20",
"NYC Additional Withholding": "14.00"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information"
payload = {
"method": "addStateW4Information",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateW4Information": {
"Filing Status": "Married",
"Withholding Allowance": "10",
"Additional Withholding": "10.10",
"NYC Withholding Allowance": "20",
"NYC Additional Withholding": "14.00"
}
}
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: 'addStateW4Information',
userId: 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
stateW4Information: {
'Filing Status': 'Married',
'Withholding Allowance': '10',
'Additional Withholding': '10.10',
'NYC Withholding Allowance': '20',
'NYC Additional Withholding': '14.00'
}
})
};
fetch('https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information', 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/userOnboarding/addStateW4Information",
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' => 'addStateW4Information',
'userId' => 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
'stateW4Information' => [
'Filing Status' => 'Married',
'Withholding Allowance' => '10',
'Additional Withholding' => '10.10',
'NYC Withholding Allowance' => '20',
'NYC Additional Withholding' => '14.00'
]
]),
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/userOnboarding/addStateW4Information"
payload := strings.NewReader("{\n \"method\": \"addStateW4Information\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateW4Information\": {\n \"Filing Status\": \"Married\",\n \"Withholding Allowance\": \"10\",\n \"Additional Withholding\": \"10.10\",\n \"NYC Withholding Allowance\": \"20\",\n \"NYC Additional Withholding\": \"14.00\"\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/userOnboarding/addStateW4Information")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addStateW4Information\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateW4Information\": {\n \"Filing Status\": \"Married\",\n \"Withholding Allowance\": \"10\",\n \"Additional Withholding\": \"10.10\",\n \"NYC Withholding Allowance\": \"20\",\n \"NYC Additional Withholding\": \"14.00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/userOnboarding/addStateW4Information")
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\": \"addStateW4Information\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateW4Information\": {\n \"Filing Status\": \"Married\",\n \"Withholding Allowance\": \"10\",\n \"Additional Withholding\": \"10.10\",\n \"NYC Withholding Allowance\": \"20\",\n \"NYC Additional Withholding\": \"14.00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"stateW4Information": {
"status": "Ready",
"message": "The StateW4Information for Steve Jobs has been saved successfully."
}
}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
