API ReferenceBusiness User Events

Create a Business User Event

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.

Headers

x-api-keystringRequired

Query parameters

allowUserTypeConversionenumOptional

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.

Allowed values:
lockKycRiskLevelenumOptional

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

Allowed values:
lockCraRiskLevelenumOptional

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

Allowed values:

Request

This endpoint expects an object.
timestampdoubleRequired>=315529200000<=4133890801000

Timestamp of the event

userIdstringRequired>=1 character

Transaction ID the event pertains to

eventIdstringOptional

Unique event ID

reasonstringOptional

Reason for the event or a state change

eventDescriptionstringOptional

Event description

updatedBusinessUserAttributesobjectOptional

Model for a business user - optional fields

Response

Created

userIdstring>=1 character

Unique user ID for the user

createdTimestampdouble>=315529200000<=4133890801000

Timestamp when the user was created

legalEntityobject

Model for business user legal entity details

activatedTimestampdoubleOptional>=315529200000<=4133890801000

Timestamp when the user was activated

userStateDetailsobjectOptional
kycStatusDetailsobjectOptional
shareHolderslist of objectsOptional

Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual

directorslist of objectsOptional

Director(s) of the company. Must be at least one

transactionLimitsobjectOptional

Model for transaction limits for a given user

riskLevelenumOptional
Allowed values:
kycRiskLevelenumOptional
Allowed values:
allowedPaymentMethodslist of enumsOptional
lastTransactionTimestampdoubleOptional

Timestamp of the last successful transaction of the user

linkedEntitiesobjectOptional
acquisitionChannelenumOptional

Model for User acquisition channel

savedPaymentDetailslist of objectsOptional
mccDetailsobjectOptional
tagslist of objectsOptional

Additional information that can be added via tags

attachmentslist of objectsOptional

User’s attachments uploaded by business user

executedRuleslist of objectsOptional
hitRuleslist of objectsOptional
riskScoreDetailsobjectOptional

Errors