FLflagright
businessUserEvents

Create a Business User Event

Changed on

POST Business User Events

/events/business/user endpoint allows you to operate on the Business User Events entity.

User events are created after the initial POST /business/users call (which creates a user) and are used to:

  • Update the STATE and KYC Status of the user, using the userStateDetails or kycStatusDetails field
  • Update the user details, using the updatedBusinessUserAttributes field.

If you have neither of the above two use cases, you do not need to use user events.

Payload

Each user event needs three mandatory fields:

  • timestamp- the timestamp of when the event was created or occured in your system
  • userId - The ID of the transaction for which this event is generated.

In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.

post/events/business/user

Request

  • Base URL
    https://sandbox.api.flagright.com
  • URL
    https://sandbox.api.flagright.com/events/business/user
  • Auth
    API key in header x-api-key

Query parameters

allowUserTypeConversion'true' | 'false'

Boolean string whether Flagright should allow a Business user event to be applied to a Consumer user with the same user ID. This will converts a Consumer user to a Business user.

lockKycRiskLevel'true' | 'false'

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

lockCraRiskLevel'true' | 'false'

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

changeUserId'true' | 'false'

Boolean string whether Flagright should change userId of the user. (Note: Only allowed for users with no associated transactions).

Request body

timestampnumber double required

Timestamp of the event

userIdstring required

Transaction ID the event pertains to

eventIdstring

Unique event ID

reasonstring

Reason for the event or a state change

eventDescriptionstring

Event description

newUserIdstring

New userId for the existing user (keep in mind all of the future requests for this user will now reference this userId). Requires the changeUserId query param to come in affect.

externalLinksstring[]

External links related to the business user

Response

Created

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

customObjectEventsBusinessUserPostResponsesContentApplicationJsonSchemaCustomObject

Typed Object defined on the console for additional data

messagestring

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

    • 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 ////