FLflagright
consumerUsers

Retrieve a Consumer User

Changed on

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

  • 1c04818a93a7Revision changes
    • warning

      added the new ANUBIS enum value to the /// response property for the response status

    • warning

      added the new APTOS enum value to the /// response property for the response status

    • warning

      added the new ARC enum value to the /// response property for the response status

    • warning

      added the new ARWEAVE enum value to the /// response property for the response status

    • warning

      added the new BERACHAIN enum value to the /// response property for the response status

    • warning

      added the new BIFROST_NETWORK enum value to the /// response property for the response status

    • warning

      added the new BITTENSOR enum value to the /// response property for the response status

    • warning

      added the new BLAST enum value to the /// response property for the response status

    • warning

      added the new BOT_CHAIN enum value to the /// response property for the response status

    • warning

      added the new CANTON_NETWORK enum value to the /// response property for the response status

    • warning

      added the new CELO enum value to the /// response property for the response status

    • warning

      added the new CHAINFLIP enum value to the /// response property for the response status

    • warning

      added the new CRONOS enum value to the /// response property for the response status

    • warning

      added the new DYDX enum value to the /// response property for the response status

    • warning

      added the new ETHEREUM_CLASSIC enum value to the /// response property for the response status

    • warning

      added the new ETHERLINK enum value to the /// response property for the response status

    • warning

      added the new FILECOIN enum value to the /// response property for the response status

    • warning

      added the new FLARE enum value to the /// response property for the response status

    • warning

      added the new FLOW enum value to the /// response property for the response status

    • warning

      added the new FRAXTAL enum value to the /// response property for the response status

    • warning

      added the new GNOSIS_CHAIN enum value to the /// response property for the response status

    • warning

      added the new HYDRATION enum value to the /// response property for the response status

    • warning

      added the new IMMUTABLE_X enum value to the /// response property for the response status

    • warning

      added the new INJECTIVE enum value to the /// response property for the response status

    • warning

      added the new INK enum value to the /// response property for the response status

    • warning

      added the new INTERNET_COMPUTER enum value to the /// response property for the response status

    • warning

      added the new IOTA enum value to the /// response property for the response status

    • warning

      added the new KAIA enum value to the /// response property for the response status

    • warning

      added the new KATANA enum value to the /// response property for the response status

    • warning

      added the new KAVA enum value to the /// response property for the response status

    • warning

      added the new LINEA enum value to the /// response property for the response status

    • warning

      added the new MANTLE enum value to the /// response property for the response status

    • warning

      added the new MEGAETH enum value to the /// response property for the response status

    • warning

      added the new MEZO enum value to the /// response property for the response status

    • warning

      added the new MIXIN enum value to the /// response property for the response status

    • warning

      added the new MONAD enum value to the /// response property for the response status

    • warning

      added the new MORPH enum value to the /// response property for the response status

    • warning

      added the new MULTIVERSX enum value to the /// response property for the response status

    • warning

      added the new OSMOSIS enum value to the /// response property for the response status

    • warning

      added the new PHAROS enum value to the /// response property for the response status

    • warning

      added the new PLASMA enum value to the /// response property for the response status

    • warning

      added the new PROVENANCE enum value to the /// response property for the response status

    • warning

      added the new PULSECHAIN enum value to the /// response property for the response status

    • warning

      added the new RISE enum value to the /// response property for the response status

    • warning

      added the new ROBINHOOD_CHAIN enum value to the /// response property for the response status

    • warning

      added the new ROLLUX enum value to the /// response property for the response status

    • warning

      added the new ROOTSTOCK enum value to the /// response property for the response status

    • warning

      added the new SCROLL enum value to the /// response property for the response status

    • warning

      added the new SEI enum value to the /// response property for the response status

    • warning

      added the new STABLE enum value to the /// response property for the response status

    • warning

      added the new STACKS enum value to the /// response property for the response status

    • warning

      added the new STARKNET enum value to the /// response property for the response status

    • warning

      added the new STORY enum value to the /// response property for the response status

    • warning

      added the new STRATO_CHAIN enum value to the /// response property for the response status

    • warning

      added the new TAIKO enum value to the /// response property for the response status

    • warning

      added the new THORCHAIN enum value to the /// response property for the response status

    • warning

      added the new TON enum value to the /// response property for the response status

    • warning

      added the new UNICHAIN enum value to the /// response property for the response status

    • warning

      added the new WORLD_CHAIN enum value to the /// response property for the response status

    • warning

      added the new XDC_NETWORK enum value to the /// response property for the response status

    • warning

      added the new XPR_NETWORK enum value to the /// response property for the response status

    • warning

      added the new X_LAYER enum value to the /// response property for the response status

    • warning

      added the new ZKSYNC_ERA enum value to the /// response property for the response status