consumerUsers

Retrieve a Consumer User

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

get/consumer/users/{userId}

Request

  • Base URL: https://sandbox.api.flagright.com
  • URL: https://sandbox.api.flagright.com/consumer/users/{userId}
  • Auth: API key in header x-api-key

Path parameters

userIdstring required

Response

OK

userIdstring required

Unique user ID

createdTimestampnumber double required

Timestamp when userId is created

activatedTimestampnumber double

Timestamp when user was activated

eoddDatenumber double
employmentStatus'UNEMPLOYED' | 'EMPLOYED' | 'SELF_EMPLOYED' | 'FREELANCER' | 'STUDENT' | 'FULL_TIME' | 'PART_TIME' | 'SOLE_PROPRIETOR' | 'PENSIONER' | 'COMPANY_OWNER' | 'OTHER' | 'NA'
occupationstring
riskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
kycRiskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
acquisitionChannel'ORGANIC' | 'PAID' | 'REFERRAL' | 'OFFLINE' | 'GATHERING' | 'UNKNOWN'

Model for User acquisition channel

reasonForAccountOpeningstring[]
sourceOfFundsSourceOfFunds[]
userSegment'RETAIL' | 'PROFESSIONAL'
sanctionsStatusboolean
adverseMediaStatusboolean
jurisdictionstring

Legal authority or region governing the transaction

externalLinksstring[]

External links related to the consumer user

customObjectUserWithRulesResultCustomObject

Typed Object defined on the console for additional data

Changes

No recorded changes to this operation across all 1 revision of this API.