consumerUserEvents

Create a Consumer User Event

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.

post/events/consumer/user

Request

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

Query parameters

allowUserTypeConversion'true' | 'false'

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.

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 queryparam to come in affect.

externalLinksstring[]

External links related to the consumer user

Response

Created

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

customObjectEventsConsumerUserPostResponsesContentApplicationJsonSchemaCustomObject

Typed Object defined on the console for additional data

messagestring

Changes

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