FLflagright
consumerUsers

Create a Consumer User

Changed on

POST Consumer User

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

In order to pass the payload of a User to Flagright and verify the User, you will need to call this endpoint with the User payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Each consumer user needs two mandatory fields:

  • userId - Unique identifier for the user
  • createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system
post/consumer/users

Request

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

Query parameters

lockCraRiskLevel'true' | 'false'

Boolean string whether Flagright should lock the CRA risk level for the user.

lockKycRiskLevel'true' | 'false'

Boolean string whether Flagright should lock the KYC risk level for the user.

validateUserId'true' | 'false'

Boolean string whether Flagright should validate the userId

Request body

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

customObjectUserCustomObject

Typed Object defined on the console for additional data

Response

Created

userIdstring required

user ID the risk score pertains to

messagestring

Changes

  • 1c04818a93a7Revision changes
    • info

      added the new ANUBIS enum value to the request property ///

    • info

      added the new APTOS enum value to the request property ///

    • info

      added the new ARC enum value to the request property ///

    • info

      added the new ARWEAVE enum value to the request property ///

    • info

      added the new BERACHAIN enum value to the request property ///

    • info

      added the new BIFROST_NETWORK enum value to the request property ///

    • info

      added the new BITTENSOR enum value to the request property ///

    • info

      added the new BLAST enum value to the request property ///

    • info

      added the new BOT_CHAIN enum value to the request property ///

    • info

      added the new CANTON_NETWORK enum value to the request property ///

    • info

      added the new CELO enum value to the request property ///

    • info

      added the new CHAINFLIP enum value to the request property ///

    • info

      added the new CRONOS enum value to the request property ///

    • info

      added the new DYDX enum value to the request property ///

    • info

      added the new ETHEREUM_CLASSIC enum value to the request property ///

    • info

      added the new ETHERLINK enum value to the request property ///

    • info

      added the new FILECOIN enum value to the request property ///

    • info

      added the new FLARE enum value to the request property ///

    • info

      added the new FLOW enum value to the request property ///

    • info

      added the new FRAXTAL enum value to the request property ///

    • info

      added the new GNOSIS_CHAIN enum value to the request property ///

    • info

      added the new HYDRATION enum value to the request property ///

    • info

      added the new IMMUTABLE_X enum value to the request property ///

    • info

      added the new INJECTIVE enum value to the request property ///

    • info

      added the new INK enum value to the request property ///

    • info

      added the new INTERNET_COMPUTER enum value to the request property ///

    • info

      added the new IOTA enum value to the request property ///

    • info

      added the new KAIA enum value to the request property ///

    • info

      added the new KATANA enum value to the request property ///

    • info

      added the new KAVA enum value to the request property ///

    • info

      added the new LINEA enum value to the request property ///

    • info

      added the new MANTLE enum value to the request property ///

    • info

      added the new MEGAETH enum value to the request property ///

    • info

      added the new MEZO enum value to the request property ///

    • info

      added the new MIXIN enum value to the request property ///

    • info

      added the new MONAD enum value to the request property ///

    • info

      added the new MORPH enum value to the request property ///

    • info

      added the new MULTIVERSX enum value to the request property ///

    • info

      added the new OSMOSIS enum value to the request property ///

    • info

      added the new PHAROS enum value to the request property ///

    • info

      added the new PLASMA enum value to the request property ///

    • info

      added the new PROVENANCE enum value to the request property ///

    • info

      added the new PULSECHAIN enum value to the request property ///

    • info

      added the new RISE enum value to the request property ///

    • info

      added the new ROBINHOOD_CHAIN enum value to the request property ///

    • info

      added the new ROLLUX enum value to the request property ///

    • info

      added the new ROOTSTOCK enum value to the request property ///

    • info

      added the new SCROLL enum value to the request property ///

    • info

      added the new SEI enum value to the request property ///

    • info

      added the new STABLE enum value to the request property ///

    • info

      added the new STACKS enum value to the request property ///

    • info

      added the new STARKNET enum value to the request property ///

    • info

      added the new STORY enum value to the request property ///

    • info

      added the new STRATO_CHAIN enum value to the request property ///

    • info

      added the new TAIKO enum value to the request property ///

    • info

      added the new THORCHAIN enum value to the request property ///

    • info

      added the new TON enum value to the request property ///

    • info

      added the new UNICHAIN enum value to the request property ///

    • info

      added the new WORLD_CHAIN enum value to the request property ///

    • info

      added the new XDC_NETWORK enum value to the request property ///

    • info

      added the new XPR_NETWORK enum value to the request property ///

    • info

      added the new X_LAYER enum value to the request property ///

    • info

      added the new ZKSYNC_ERA enum value to the request property ///