businessUsers

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

get/business/users/{userId}

Request

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

Path parameters

userIdstring required

Response

OK

userIdstring required

Unique user ID for the user

createdTimestampnumber double required

Timestamp when the user was created

activatedTimestampnumber double

Timestamp when the user was activated

eoddDatenumber double
riskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
kycRiskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
allowedPaymentMethodsPaymentMethod[]
acquisitionChannel'ORGANIC' | 'PAID' | 'REFERRAL' | 'OFFLINE' | 'GATHERING' | 'UNKNOWN'

Model for User acquisition channel

jurisdictionstring

Legal authority or region governing the transaction

sanctionsStatusboolean

Whether the user is sanctioned

adverseMediaStatusboolean

Whether the user is in the adverse media list

externalLinksstring[]

External links related to the business user

customObjectBusinessWithRulesResultCustomObject

Typed Object defined on the console for additional data

Changes

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