API ReferenceBusiness Users

Create a Business User

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

Headers

x-api-keystringRequired

Query parameters

lockCraRiskLevelenumOptional

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

Allowed values:
lockKycRiskLevelenumOptional

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

Allowed values:
validateUserIdenumOptional

Boolean string whether Flagright should validate the userId

Allowed values:
_krsOnlyenumOptional
Allowed values:

Request

This endpoint expects an object.
userIdstringRequired>=1 character

Unique user ID for the user

createdTimestampdoubleRequired>=315529200000<=4133890801000

Timestamp when the user was created

legalEntityobjectRequired

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

Response

Created

userIdstring>=1 character

user ID the risk score pertains to

executedRuleslist of objectsOptional
hitRuleslist of objectsOptional
messagestringOptional
riskScoreDetailsobjectOptional

Errors