updateKycInformation

curl --request PUT \
  --url 'https://sandbox.rollfi.xyz/userOnboarding#updateKycInformation' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "updateKycInformation",
  "kycInformation": {
    "userId": "e066e305-3816-4b06-8576-50d2502be436",
    "ssn": "789895512",
    "dateOfBirth": "2000-01-01",
    "address1": "650 Capitol Mall",
    "address2": "",
    "city": "e",
    "state": "Sacramento",
    "zipcode": "95814"
  },
  "userRemoteLocation": {
    "address1": "e",
    "address2": "e",
    "city": "e",
    "state": "AZ",
    "zipcode": "50023"
  }
}
'

{
  "kycInformation": {
    "userIdId": "e066e305-3816-4b06-8576-50d2502be436",
    "status": "Ready",
    "message": "The KYCInformation has been updated successfully."
  }
}

User Onboarding

updateKycInformation

The updateKycInformation API is used to modify previously submitted identity information for employees when changes are needed.

What it does:

Updates existing KYC data (address, phone number, personal details)
Can update the remote work location for employees to ensure they receive the correct state tax filing
Requires kyc to already have been added using the addKycInformation API

⚠️ Warnings:

ssn cannot be changed when the employee is Active since they have passed KYB. To change an employee’s ssn please contact support
userRemoteLocation should only be provided if the employee is remote and works from a location which is not their home address

PUT

userOnboarding#updateKycInformation

updateKycInformation

curl --request PUT \
  --url 'https://sandbox.rollfi.xyz/userOnboarding#updateKycInformation' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "updateKycInformation",
  "kycInformation": {
    "userId": "e066e305-3816-4b06-8576-50d2502be436",
    "ssn": "789895512",
    "dateOfBirth": "2000-01-01",
    "address1": "650 Capitol Mall",
    "address2": "",
    "city": "e",
    "state": "Sacramento",
    "zipcode": "95814"
  },
  "userRemoteLocation": {
    "address1": "e",
    "address2": "e",
    "city": "e",
    "state": "AZ",
    "zipcode": "50023"
  }
}
'

{
  "kycInformation": {
    "userIdId": "e066e305-3816-4b06-8576-50d2502be436",
    "status": "Ready",
    "message": "The KYCInformation has been updated successfully."
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

required

Example:

"updateKycInformation"

kycInformation

object

required

Show child attributes

employeeRemoteLocation

object

Show child attributes

Response

kycInformation

object

Show child attributes

initiateUserKyc addStateW4Information

API Reference

Authorizations

Body

Response