Create a Business User

POST

POST Business User

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

In order to pass the payload of a User to Flagright and verify the User, you will need to call this endpoint with the User payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Each business user needs three mandatory fields:

  • userId - Unique identifier for the user
  • legalEntity - Details of the business legal entity (CompanyGeneralDetails, FinancialDetails etc) - only legalNamein CompanyGeneralDetails is mandatory
  • createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system

Request

This endpoint expects an object.
userIdstringRequired
Unique user ID for the user
createdTimestampdoubleRequired
Timestamp when the user was created
legalEntityobjectRequired
Model for business user legal entity details
activatedTimestampdoubleOptional
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: VERY_HIGHHIGHMEDIUMLOWVERY_LOW
allowedPaymentMethodslist of enumsOptional
linkedEntitiesobjectOptional
acquisitionChannelenumOptional
Model for User acquisition channel
savedPaymentDetailslist of objectsOptional
mccDetailsobjectOptional
tagslist of objectsOptional
Additional information that can be added via tags

Response

This endpoint returns an object.
userIdstring
user ID the risk score pertains to
executedRuleslist of objectsOptional
Model for list of executed rules
hitRuleslist of objectsOptional
Model for list of hit rules
messagestringOptional
riskScoreDetailsobjectOptional

Errors

Built with