1. Users
  2. Add KYC or KYB information for User
POST

/api/api/users/add_kyc_information

client_id*
api_key*
curl --request POST \
     --url https://api.senddotssandbox.com/api/api/users/add_kyc_information \
     --header 'Authorization: Basic AUTH_VALUE' \
     --header 'Content-Type: application/json' \
     --data '{
 "user_id": "string",
 "entity_type": "string",
 "postcode": "string",
 "city": "string",
 "country": "string",
 "state": "string",
 "line1": "string"
}'
{
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "entity_type": "individual",
  "business_name": "string",
  "postcode": "string",
  "city": "string",
  "country": "AU",
  "state": "AL",
  "line1": "string",
  "line2": "string",
  "ssn": "string",
  "ein": "string"
}
{
  "success": true,
  "message": "SSN did not match"
}

Body

user_idRequired
string
entity_typeRequired
string
Available options: individual, business
business_name
string

required if entity_type = business

postcodeRequired
string
cityRequired
string
countryRequired
string
Available options: AU, AT, BE, BR, BG, CA, CY, CZ, DK, EE, FI, FR, DE, GR, HK, HU, IE, IT, JP, LV, LT, LU, MT, NL, NC, NO, PL, PT, RO, SG, SK, SI, ES, SE, CH, AE, GB, US
stateRequired
string
Available options: AL, AK, AS, AZ, AR, CA, CO, CT, DE, DC, FM, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MH, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, MP, OH, OK, OR, PW, PA, PR, RI, SC, SD, TN, TX, UT, VT, VI, VA, WA, WV, WI, WY
line1Required
string
line2
string
ssn
string

required if entity_type = individual

ein
string

required if entity_type = business

Response

success
boolean
message
string

Error message if success is false