Retrieve a Consumer User | Flagright

{
  "userId": "96647cfd9e8fe66ee0f3362e011e34e8",
  "createdTimestamp": 1641654664000,
  "userDetails": {
    "name": {
      "firstName": "Baran",
      "middleName": "Realblood",
      "lastName": "Ozkan"
    },
    "dateOfBirth": "1991-01-01",
    "countryOfResidence": "US",
    "countryOfNationality": "DE"
  },
  "legalDocuments": [
    {
      "documentType": "passport",
      "documentNumber": "Z9431P",
      "documentIssuedDate": 1639939034000,
      "documentExpirationDate": 1839939034000,
      "documentIssuedCountry": "DE",
      "tags": [
        {
          "key": "customerType",
          "value": "wallet"
        }
      ]
    }
  ],
  "contactDetails": {
    "emailIds": [
      "baran@flagright.com"
    ],
    "contactNumbers": [
      "+37112345432"
    ],
    "websites": [
      "flagright.com"
    ],
    "addresses": [
      {
        "addressLines": [
          "Klara-Franke Str 20"
        ],
        "postcode": "10557",
        "city": "Berlin",
        "state": "Berlin",
        "country": "Germany",
        "tags": [
          {
            "key": "customKey",
            "value": "customValue"
          }
        ]
      }
    ]
  },
  "tags": [
    {
      "key": "customKey",
      "value": "customValue"
    }
  ],
  "riskScoreDetails": {
    "kycRiskScore": 11.72,
    "craRiskScore": 41.72,
    "kycRiskLevel": "MEDIUM",
    "craRiskLevel": "HIGH"
  }
}

GET Consumer User

/consumer/user endpoint allows you to operate on the Consumer User entity.

Calling GET /consumer/user/{userId} will return the entire user payload and rule execution results for the user with the corresponding userId

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

userIdstringRequired

Response

userIdstring>=1 character

Unique user ID

createdTimestampdouble315529200000-4133890801000

Timestamp when userId is created

activatedTimestampdoubleOptional315529200000-4133890801000

Timestamp when user was activated

userDetailsobjectOptional

Model for consumer user personal details

userStateDetailsobjectOptional

kycStatusDetailsobjectOptional

eoddDatedoubleOptional315529200000-4133890801000

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

expectedTransactionCountriesobjectOptional

Model for expected transaction countries

expectedTransactionCurrenciesobjectOptional

Model for expected transaction currencies

riskLevelenumOptional

kycRiskLevelenumOptional

acquisitionChannelenumOptional

Model for User acquisition channel

reasonForAccountOpeninglist of stringsOptional

sourceOfFundslist of enumsOptional

userSegmentenumOptional

pepStatuslist of objectsOptional

sanctionsStatusbooleanOptional

adverseMediaStatusbooleanOptional

corporateEntitieslist of objectsOptional

Corporate entities of the user

linkedEntitiesobjectOptional

savedPaymentDetailslist of objectsOptional

tagslist of objectsOptional

Additional information that can be added via tags

attachmentslist of objectsOptional

Uploaded user's attachment

metaDataobjectOptional

Model for device data

jurisdictionstringOptional

Legal authority or region governing the transaction

productsEnabledlist of objectsOptional

externalLinkslist of stringsOptional

External links related to the consumer user

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

riskScoreDetailsobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error