Create a Consumer User — Flagright

POST Consumer User

/consumer/user endpoint allows you to operate on the Consumer 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 consumer user needs two mandatory fields:

userId - Unique identifier for the user
createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system

Query parameters

lockCraRiskLevel"true" or "false"Optional

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

Allowed values: truefalse

validateUserId"true" or "false"Optional

Boolean string whether Flagright should validate the userId

Allowed values: truefalse

_krsOnly"true" or "false"Optional

Allowed values: truefalse

Request

This endpoint expects an object.

userIdstringRequired

Unique user ID

createdTimestampdoubleRequired

Timestamp when userId is created

activatedTimestampdoubleOptional

Timestamp when user was activated

userDetailsobjectOptional

Model for consumer user personal details

userStateDetailsobjectOptional

kycStatusDetailsobjectOptional

employmentStatusenumOptional

occupationstringOptional

legalDocumentslist of objectsOptional

User’s legal identity documents - See Document Model for details

contactDetailsobjectOptional

Model for business user contact information details

employmentDetailsobjectOptional

Details of User’s employment

transactionLimitsobjectOptional

Model for transaction limits for a given user

expectedIncomeobjectOptional

Model for expected income details

riskLevelenumOptional

Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW

acquisitionChannelenumOptional

Model for User acquisition channel

reasonForAccountOpeninglist of stringsOptional

sourceOfFundslist of enumsOptional

userSegment"RETAIL" or "PROFESSIONAL"Optional

Allowed values: RETAILPROFESSIONAL

pepStatuslist of objectsOptional

lastTransactionTimestampdoubleOptional

Timestamp of the last successful transaction of the user

linkedEntitiesobjectOptional

savedPaymentDetailslist of objectsOptional

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

hitRuleslist of objectsOptional

messagestringOptional

riskScoreDetailsobjectOptional

Errors

1 curl -X POST https://sandbox.api.flagright.com/consumer/users \ 2 -H "x-api-key: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "userId": "96647cfd9e8fe66ee0f3362e011e34e8", 6 "createdTimestamp": 1641654664000, 7 "userDetails": { 8 "name": { 9 "firstName": "Baran", 10 "middleName": "Realblood", 11 "lastName": "Ozkan" 12 }, 13 "dateOfBirth": "1991-01-01", 14 "countryOfResidence": "US", 15 "countryOfNationality": "DE" 16 }, 17 "legalDocuments": [ 18 { 19 "documentType": "passport", 20 "documentNumber": "Z9431P", 21 "documentIssuedCountry": "DE", 22 "documentIssuedDate": 1639939034000, 23 "documentExpirationDate": 1839939034000, 24 "tags": [ 25 { 26 "key": "customerType", 27 "value": "wallet" 28 } 29 ] 30 } 31 ], 32 "contactDetails": { 33 "emailIds": [ 34 "baran@flagright.com" 35 ], 36 "contactNumbers": [ 37 "+37112345432" 38 ], 39 "websites": [ 40 "flagright.com" 41 ], 42 "addresses": [ 43 { 44 "addressLines": [ 45 "Klara-Franke Str 20" 46 ], 47 "postcode": "10557", 48 "city": "Berlin", 49 "state": "Berlin", 50 "country": "Germany", 51 "tags": [ 52 { 53 "key": "customKey", 54 "value": "customValue" 55 } 56 ] 57 } 58 ] 59 }, 60 "tags": [ 61 { 62 "key": "customKey", 63 "value": "customValue" 64 } 65 ] 66 }'

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 "executedAt": 1.1, 12 "vars": [ 13 { 14 "value": {} 15 } 16 ], 17 "labels": [ 18 "UNEXPECTED_BEHAVIOR" 19 ], 20 "nature": "AML", 21 "isShadow": true 22 } 23 ], 24 "hitRules": [ 25 { 26 "ruleInstanceId": "ruleInstanceId", 27 "ruleName": "Proof of funds for high value transactions", 28 "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds", 29 "ruleAction": "BLOCK", 30 "ruleId": "R-1a", 31 "executedAt": 1.1, 32 "labels": [ 33 "UNEXPECTED_BEHAVIOR" 34 ], 35 "nature": "FRAUD", 36 "isShadow": true 37 } 38 ], 39 "message": "message", 40 "riskScoreDetails": { 41 "kycRiskScore": 1.1, 42 "craRiskScore": 1.1, 43 "kycRiskLevel": "VERY_HIGH", 44 "craRiskLevel": "VERY_HIGH" 45 } 46 }

1	curl -X POST https://sandbox.api.flagright.com/consumer/users \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"userId": "96647cfd9e8fe66ee0f3362e011e34e8",
6	"createdTimestamp": 1641654664000,
7	"userDetails": {
8	"name": {
9	"firstName": "Baran",
10	"middleName": "Realblood",
11	"lastName": "Ozkan"
12	},
13	"dateOfBirth": "1991-01-01",
14	"countryOfResidence": "US",
15	"countryOfNationality": "DE"
16	},
17	"legalDocuments": [
18	{
19	"documentType": "passport",
20	"documentNumber": "Z9431P",
21	"documentIssuedCountry": "DE",
22	"documentIssuedDate": 1639939034000,
23	"documentExpirationDate": 1839939034000,
24	"tags": [
25	{
26	"key": "customerType",
27	"value": "wallet"
28	}
29	]
30	}
31	],
32	"contactDetails": {
33	"emailIds": [
34	"baran@flagright.com"
35	],
36	"contactNumbers": [
37	"+37112345432"
38	],
39	"websites": [
40	"flagright.com"
41	],
42	"addresses": [
43	{
44	"addressLines": [
45	"Klara-Franke Str 20"
46	],
47	"postcode": "10557",
48	"city": "Berlin",
49	"state": "Berlin",
50	"country": "Germany",
51	"tags": [
52	{
53	"key": "customKey",
54	"value": "customValue"
55	}
56	]
57	}
58	]
59	},
60	"tags": [
61	{
62	"key": "customKey",
63	"value": "customValue"
64	}
65	]
66	}'

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	"executedAt": 1.1,
12	"vars": [
13	{
14	"value": {}
15	}
16	],
17	"labels": [
18	"UNEXPECTED_BEHAVIOR"
19	],
20	"nature": "AML",
21	"isShadow": true
22	}
23	],
24	"hitRules": [
25	{
26	"ruleInstanceId": "ruleInstanceId",
27	"ruleName": "Proof of funds for high value transactions",
28	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
29	"ruleAction": "BLOCK",
30	"ruleId": "R-1a",
31	"executedAt": 1.1,
32	"labels": [
33	"UNEXPECTED_BEHAVIOR"
34	],
35	"nature": "FRAUD",
36	"isShadow": true
37	}
38	],
39	"message": "message",
40	"riskScoreDetails": {
41	"kycRiskScore": 1.1,
42	"craRiskScore": 1.1,
43	"kycRiskLevel": "VERY_HIGH",
44	"craRiskLevel": "VERY_HIGH"
45	}
46	}