Retrieve a Business User

GET
/business/users/:userId

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

Response

This endpoint returns an object.
userIdstring

Unique user ID for the user

createdTimestampdouble

Timestamp when the user was created

legalEntityobject

Model for business user legal entity details

activatedTimestampdoubleOptional

Timestamp when the user was activated

userStateDetailsobjectOptional
kycStatusDetailsobjectOptional
shareHolderslist of objectsOptional

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

directorslist of objectsOptional

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

transactionLimitsobjectOptional

Model for transaction limits for a given user

riskLevelenumOptional
Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW
kycRiskLevelenumOptional
Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW
allowedPaymentMethodslist of enumsOptional
lastTransactionTimestampdoubleOptional

Timestamp of the last successful transaction of the user

linkedEntitiesobjectOptional
acquisitionChannelenumOptional

Model for User acquisition channel

savedPaymentDetailslist of objectsOptional
mccDetailsobjectOptional
tagslist of objectsOptional

Additional information that can be added via tags

attachmentslist of objectsOptional

User’s attachments uploaded by business user

executedRuleslist of objectsOptional
hitRuleslist of objectsOptional
riskScoreDetailsobjectOptional

Errors

Built with