consumerUsers

Create a Consumer User

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

Request

  • Base URL: https://sandbox.api.flagright.com
  • URL: https://sandbox.api.flagright.com/consumer/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

createdTimestampnumber double required

Timestamp when userId is created

activatedTimestampnumber double

Timestamp when user was activated

eoddDatenumber double
employmentStatus'UNEMPLOYED' | 'EMPLOYED' | 'SELF_EMPLOYED' | 'FREELANCER' | 'STUDENT' | 'FULL_TIME' | 'PART_TIME' | 'SOLE_PROPRIETOR' | 'PENSIONER' | 'COMPANY_OWNER' | 'OTHER' | 'NA'
occupationstring
riskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
kycRiskLevel'VERY_HIGH' | 'HIGH' | 'MEDIUM' | 'LOW' | 'VERY_LOW'
acquisitionChannel'ORGANIC' | 'PAID' | 'REFERRAL' | 'OFFLINE' | 'GATHERING' | 'UNKNOWN'

Model for User acquisition channel

reasonForAccountOpeningstring[]
sourceOfFundsSourceOfFunds[]
userSegment'RETAIL' | 'PROFESSIONAL'
sanctionsStatusboolean
adverseMediaStatusboolean
jurisdictionstring

Legal authority or region governing the transaction

externalLinksstring[]

External links related to the consumer user

customObjectUserCustomObject

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.