Retrieve a Consumer User

GET
/consumer/users/:userId

GET Consumer User

/consumer/user endpoint allows you to operate on the Consumer User entity.

Calling GET /consumer/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

createdTimestampdouble

Timestamp when userId is created

activatedTimestampdoubleOptional

Timestamp when user was activated

userDetailsobjectOptional

Model for consumer user personal details

userStateDetailsobjectOptional
kycStatusDetailsobjectOptional
employmentStatusenumOptional
occupationstringOptional
legalDocumentslist of objectsOptional

User’s legal identity documents - See Document Model for details

contactDetailsobjectOptional

Model for business user contact information details

employmentDetailsobjectOptional

Details of User’s employment

transactionLimitsobjectOptional

Model for transaction limits for a given user

expectedIncomeobjectOptional

Model for expected income details

riskLevelenumOptional
Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW
acquisitionChannelenumOptional

Model for User acquisition channel

reasonForAccountOpeninglist of stringsOptional
sourceOfFundslist of enumsOptional
userSegment"RETAIL" or "PROFESSIONAL"Optional
Allowed values: RETAILPROFESSIONAL
pepStatuslist of objectsOptional
lastTransactionTimestampdoubleOptional

Timestamp of the last successful transaction of the user

linkedEntitiesobjectOptional
savedPaymentDetailslist of objectsOptional
tagslist of objectsOptional

Additional information that can be added via tags

executedRuleslist of objectsOptional
hitRuleslist of objectsOptional
riskScoreDetailsobjectOptional

Errors

Built with