Retrieve a Business User | Flagright

import { FlagrightClient } from "flagright";
async function main() {
    const client = new FlagrightClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.businessUsers.get("userId");
}
main();

{
  "userId": "96647cfd9e8fe66ee0f3362e011e34e8",
  "createdTimestamp": 1641654664000,
  "legalEntity": {
    "companyGeneralDetails": {
      "legalName": "Ozkan Hazelnut Export JSC",
      "businessIndustry": [
        "Farming"
      ],
      "mainProductsServicesSold": [
        "Hazelnut"
      ]
    },
    "companyFinancialDetails": {
      "expectedTransactionAmountPerMonth": {
        "amountValue": 800,
        "amountCurrency": "GBP"
      },
      "expectedTurnoverPerMonth": {
        "amountValue": 8000,
        "amountCurrency": "USD"
      }
    },
    "companyRegistrationDetails": {
      "registrationIdentifier": "PSJ554342",
      "registrationCountry": "DE"
    },
    "reasonForAccountOpening": [
      "string"
    ],
    "contactDetails": {
      "addresses": [
        {
          "addressLines": [
            "Klara-Franke Str 20"
          ],
          "postcode": "10557",
          "city": "Berlin",
          "state": "Berlin",
          "country": "Germany",
          "tags": [
            {
              "key": "customKey",
              "value": "customValue"
            }
          ]
        }
      ]
    }
  },
  "shareHolders": [
    {
      "generalDetails": {
        "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": [
          "+371 123132"
        ],
        "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"
        }
      ]
    }
  ],
  "directors": [
    {
      "generalDetails": {
        "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": [
          "+371 123132"
        ],
        "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"
        }
      ]
    }
  ],
  "tags": [
    {
      "key": "customKey",
      "value": "customValue"
    }
  ],
  "riskScoreDetails": {
    "kycRiskScore": 11.72,
    "craRiskScore": 41.72,
    "kycRiskLevel": "MEDIUM",
    "craRiskLevel": "HIGH"
  }
}

GET Business User

/business/user endpoint allows you to operate on the Business User entity.

Calling GET /business/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 for the user

createdTimestampdouble315529200000-4133890801000

Timestamp when the user was created

legalEntityobject

Model for business user legal entity details

activatedTimestampdouble or null315529200000-4133890801000

Timestamp when the user was activated

userStateDetailsobject or null

kycStatusDetailsobject or null

eoddDatedouble or null

corporateEntitieslist of objects or null

Corporate entities of the user

shareHolderslist of objects or null

Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual

directorslist of objects or null

Director(s) of the company. Must be at least one

associatedPartieslist of objects or null

Parties associated with the company. Can be another company or an individual

businessPartnerslist of objects or null

Business partners of the company

transactionLimitsobject or null

Model for transaction limits for a given user

expectedTransactionCountriesobject or null

Model for expected transaction countries

riskLevelenum or null

Allowed values:

kycRiskLevelenum or null

Allowed values:

allowedPaymentMethodslist of enums or null

linkedEntitiesobject or null

acquisitionChannelenum or null

Model for User acquisition channel

savedPaymentDetailslist of objects or null

mccDetailsobject or null

tagslist of objects or null

Additional information that can be added via tags

attachmentslist of objects or null

User's attachments uploaded by business user

metaDataobject or null

Model for device data

jurisdictionstring or null

Legal authority or region governing the transaction

productsEnabledlist of objects or null

pepStatuslist of objects or null

sanctionsStatusboolean or null

Whether the user is sanctioned

adverseMediaStatusboolean or null

Whether the user is in the adverse media list

executedRuleslist of objects or null

hitRuleslist of objects or null

riskScoreDetailsobject or null

GET Business User

Authentication

Path parameters

Response

Errors