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
orkycStatusDetails
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 systemuserId
- 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.