Users
Add KYC or KYB information for User
POST
/
api
/
users
/
add_kyc_information
Authorization
Body
{
"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"
}
Authorizations
Authorizationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
business_name
string
required if entity_type = business
cityrequired
string
countryrequired
enum<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
ein
string
required if entity_type = business
entity_typerequired
enum<string>
Available options:
individual
, business
line1required
string
line2
string
postcoderequired
string
ssn
string
required if entity_type = individual
staterequired
enum<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
user_idrequired
string
Response
200 - application/json
message
string
Error message if success is false
success
boolean
{
"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"
}