API ReferenceBusiness Users

Retrieve a Business User

GET Business User

/business/user endpoint allows you to operate on the Business User entity.

Calling GET /business/user/{userId} will return the entire User payload and rule execution results for the User with the corresponding userId

Path parameters

userIdstringRequired

Headers

x-api-keystringRequired

Response

OK
userIdstring>=1 character
Unique user ID for the user
createdTimestampdouble>=315529200000<=4133890801000
Timestamp when the user was created
legalEntityobject
Model for business user legal entity details
activatedTimestampdouble or null>=315529200000<=4133890801000
Timestamp when the user was activated
userStateDetailsobject or null
kycStatusDetailsobject or null
shareHolderslist of objects or null

Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual

directorslist of objects or null

Director(s) of the company. Must be at least one

transactionLimitsobject or null
Model for transaction limits for a given user
riskLevelenum or null
Allowed values:
kycRiskLevelenum or null
Allowed values:
allowedPaymentMethodslist of enums or null
linkedEntitiesobject or null
acquisitionChannelenum or null
Model for User acquisition channel
savedPaymentDetailslist of objects or null
mccDetailsobject or null
tagslist of objects or null
Additional information that can be added via tags
attachmentslist of objects or null
User's attachments uploaded by business user
executedRuleslist of objects or null
hitRuleslist of objects or null
riskScoreDetailsobject or null

Errors