Business Users

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.
userId
stringRequired
Unique user ID for the user
createdTimestamp
doubleRequired
Timestamp when the user was created
legalEntity
objectRequired
Model for business user legal entity details
userStateDetails
objectOptional
kycStatusDetails
objectOptional
shareHolders
list of objectsOptional
Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual
directors
list of objectsOptional
Director(s) of the company. Must be at least one
transactionLimits
objectOptional
Model for transaction limits for a given user
riskLevel
enumOptional
Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW
allowedPaymentMethods
list of enumsOptional
linkedEntities
objectOptional
acquisitionChannel
enumOptional
Model for User acquisition channel
savedPaymentDetails
list of unionsOptional
mccDetails
objectOptional
tags
list of objectsOptional
Additional information that can be added via tags

Response

This endpoint returns an object
userId
string
user ID the risk score pertains to
executedRules
list of objectsOptional
Model for list of executed rules
hitRules
list of objectsOptional
Model for list of hit rules
message
stringOptional
riskScoreDetails
objectOptional

Errors

POST
1curl -X POST https://sandbox.api.flagright.com/business/users \
2 -H "x-api-key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "userId": "userId",
6 "createdTimestamp": 1.1,
7 "legalEntity": {
8 "companyGeneralDetails": {
9 "legalName": "Ozkan Hazelnut Export JSC",
10 "businessIndustry": [
11 "Farming"
12 ],
13 "mainProductsServicesSold": [
14 "Hazelnut"
15 ]
16 }
17 }
18}'
1{
2 "userId": "96647cfd9e8fe66ee0f3362e011e34e8",
3 "executedRules": [
4 {
5 "ruleInstanceId": "ruleInstanceId",
6 "ruleName": "Proof of funds for high value transactions",
7 "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
8 "ruleAction": "BLOCK",
9 "ruleHit": true,
10 "ruleId": "R-1a",
11 "vars": [
12 {
13 "value": {}
14 }
15 ],
16 "labels": [
17 "UNEXPECTED_BEHAVIOR"
18 ],
19 "nature": "AML",
20 "isShadow": true
21 }
22 ],
23 "hitRules": [
24 {
25 "ruleInstanceId": "ruleInstanceId",
26 "ruleName": "Proof of funds for high value transactions",
27 "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
28 "ruleAction": "BLOCK",
29 "ruleId": "R-1a",
30 "labels": [
31 "UNEXPECTED_BEHAVIOR"
32 ],
33 "nature": "FRAUD",
34 "isShadow": true
35 }
36 ],
37 "message": "message",
38 "riskScoreDetails": {
39 "kycRiskScore": 1.1,
40 "craRiskScore": 1.1,
41 "kycRiskLevel": "VERY_HIGH",
42 "craRiskLevel": "VERY_HIGH"
43 }
44}