API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- Webhooks
User Onboarding
AddKycInformation
POST
/
userOnboarding#addKycInformation
Copy
curl --request POST \
--url 'https://sandbox.rollfi.xyz/userOnboarding#addKycInformation' \
--header 'Content-Type: application/json' \
--data '{
"method": "addKycInformation",
"kycInformation": {
"userId": "5a2390e1-0f83-46bd-ae1c-81b30fe364e1",
"ssn": "789898953",
"dateOfBirth": "2000-01-01",
"address1": "777 West Convention Way",
"address2": "",
"city": "Anaheim",
"state": "CA",
"zipcode": "92802"
},
"userRemoteLocation": {
"address1": "e",
"address2": "e",
"city": "e",
"state": "AZ",
"zipcode": "50023"
}
}'
Copy
{
"summary": "Success",
"value": {
"kycInformation": {
"userId": "5a2390e1-0f83-46bd-ae1c-81b30fe364e1",
"status": "KYC Pending",
"message": "The KYC Information for jacob king has been added successfully."
}
}
}
Body
application/json
Example:
["addKycInformation"]
Example:
["659-89-9874"]
Maximum length:
10
Maximum length:
40
Maximum length:
40
Available 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
Maximum length:
40
Maximum length:
40
Maximum length:
40
Available 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
Maximum length:
40
Copy
curl --request POST \
--url 'https://sandbox.rollfi.xyz/userOnboarding#addKycInformation' \
--header 'Content-Type: application/json' \
--data '{
"method": "addKycInformation",
"kycInformation": {
"userId": "5a2390e1-0f83-46bd-ae1c-81b30fe364e1",
"ssn": "789898953",
"dateOfBirth": "2000-01-01",
"address1": "777 West Convention Way",
"address2": "",
"city": "Anaheim",
"state": "CA",
"zipcode": "92802"
},
"userRemoteLocation": {
"address1": "e",
"address2": "e",
"city": "e",
"state": "AZ",
"zipcode": "50023"
}
}'
Copy
{
"summary": "Success",
"value": {
"kycInformation": {
"userId": "5a2390e1-0f83-46bd-ae1c-81b30fe364e1",
"status": "KYC Pending",
"message": "The KYC Information for jacob king has been added successfully."
}
}
}