Company Onboarding
addCompanyLocation
- Documentation
- API Reference
Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
Reports
API Reference
Company Onboarding
addCompanyLocation
Add Company Location
To add a company location.
Location Details:
Payroll process requires the company’s mailing address, filing address and all addresses where the company has employees physically working in the United States.
POST
/
companyOnboarding#addCompanyLocation
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
addCompanyLocation · string
*
method
Required
string
Add Example Value
companyLocation
object
*
companyLocation
Required
object
companyId
string
*
companyId
Required
string
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
boolean
isMailingAddress
boolean
isMailingAddress
boolean
isFilingAddress
boolean
isFilingAddress
boolean
curl --request POST \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#addCompanyLocation' \
--header 'Content-Type: application/json' \
--data '{
"method": "addCompanyLocation",
"companyLocation": {
"companyId": "8b77ce43-4596-4af7-bf1b-3bfc946ad5e4",
"companyLocation": "Main",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"phoneNumber": "9889890989",
"isWorkLocation": true,
"isMailingAddress": true,
"isFilingAddress": true
}
}'{
"1": {
"summary": "Success",
"value": {
"companyLocation": {
"companyLocationId": "EAE2367A-F86E-4495-B403-627FCCFD8184",
"status": "Verification pending",
"message": "Company Location has been saved successfully."
}
}
}
}Body
application/json
method
string
default: addCompanyLocationrequiredcompanyLocation
object
requiredcompanyLocation.companyId
string
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
companyLocation.isMailingAddress
boolean
companyLocation.isFilingAddress
boolean
Response
200 - application/json
companyLocation
object
requiredcompanyLocation.companyLocationId
string
requiredcompanyLocation.status
string
requiredcompanyLocation.message
string
curl --request POST \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#addCompanyLocation' \
--header 'Content-Type: application/json' \
--data '{
"method": "addCompanyLocation",
"companyLocation": {
"companyId": "8b77ce43-4596-4af7-bf1b-3bfc946ad5e4",
"companyLocation": "Main",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"phoneNumber": "9889890989",
"isWorkLocation": true,
"isMailingAddress": true,
"isFilingAddress": true
}
}'{
"1": {
"summary": "Success",
"value": {
"companyLocation": {
"companyLocationId": "EAE2367A-F86E-4495-B403-627FCCFD8184",
"status": "Verification pending",
"message": "Company Location has been saved successfully."
}
}
}
}