Create a Consumer User Event

POST

POST Consumer User Events

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

User events are created after the initial POST /consumer/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 updatedConsumerUserAttributes 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.

Query parameters

allowUserTypeConversion"true" or "false"Optional
Boolean string whether Flagright should allow a Consumer user event to be applied to a Business user with the same user ID. This will converts a Business user to a Consumer user.
Allowed values: truefalse

Request

This endpoint expects an object.
timestampdoubleRequired
Timestamp of the event
userIdstringRequired
Transaction ID the event pertains to
eventIdstringOptional
Unique event ID
reasonstringOptional
Reason for the event or a state change
eventDescriptionstringOptional
Event description
updatedConsumerUserAttributesobjectOptional
Model for User details

Response

This endpoint returns an object.
userIdstring
Unique user ID
createdTimestampdouble
Timestamp when userId is created
activatedTimestampdoubleOptional
Timestamp when user was activated
userDetailsobjectOptional
Model for consumer user personal details
userStateDetailsobjectOptional
kycStatusDetailsobjectOptional
employmentStatusenumOptional
occupationstringOptional
legalDocumentslist of objectsOptional
User's legal identity documents - See Document Model for details
contactDetailsobjectOptional
Model for business user contact information details
employmentDetailsobjectOptional
Details of User's employment
transactionLimitsobjectOptional
Model for transaction limits for a given user
expectedIncomeobjectOptional
Model for expected income details
riskLevelenumOptional
Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW
acquisitionChannelenumOptional
Model for User acquisition channel
reasonForAccountOpeninglist of stringsOptional
sourceOfFundslist of enumsOptional
userSegment"RETAIL" or "PROFESSIONAL"Optional
Allowed values: RETAILPROFESSIONAL
pepStatuslist of objectsOptional
linkedEntitiesobjectOptional
savedPaymentDetailslist of objectsOptional
tagslist of objectsOptional
Additional information that can be added via tags
executedRuleslist of objectsOptional
Model for list of executed rules
hitRuleslist of objectsOptional
Model for list of hit rules
riskScoreDetailsobjectOptional

Errors

Built with