businessUsers

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
post/business/users

Request

  • Base URL: https://sandbox.api.flagright.com
  • URL: https://sandbox.api.flagright.com/business/users
  • Auth: API key in header x-api-key

Query parameters

lockCraRiskLevel'true' | 'false'

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

lockKycRiskLevel'true' | 'false'

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

validateUserId'true' | 'false'

Boolean string whether Flagright should validate the userId

Request body

userIdstring required

Unique user ID for the user

createdTimestampnumber double required

Timestamp when the user was created

activatedTimestampnumber double

Timestamp when the user was activated

eoddDatenumber double
riskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
kycRiskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
allowedPaymentMethodsPaymentMethod[]
acquisitionChannel'ORGANIC' | 'PAID' | 'REFERRAL' | 'OFFLINE' | 'GATHERING' | 'UNKNOWN'

Model for User acquisition channel

jurisdictionstring

Legal authority or region governing the transaction

sanctionsStatusboolean

Whether the user is sanctioned

adverseMediaStatusboolean

Whether the user is in the adverse media list

externalLinksstring[]

External links related to the business user

customObjectBusinessCustomObject

Typed Object defined on the console for additional data

Response

Created

userIdstring required

user ID the risk score pertains to

messagestring

Changes

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