Retrieve a Business User | Flagright

{
  "userId": "96647cfd9e8fe66ee0f3362e011e34e8",
  "createdTimestamp": 1641654664000,
  "legalEntity": {
    "companyGeneralDetails": {
      "legalName": "Ozkan Hazelnut Export JSC",
      "businessIndustry": [
        "Farming"
      ],
      "secondaryBusinessIndustry": [
        "Food Processing"
      ],
      "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

activatedTimestampdouble315529200000-4133890801000

Timestamp when the user was activated

userStateDetailsobject

kycStatusDetailsobject

eoddDatedouble315529200000-4133890801000

corporateEntitieslist of objects

Corporate entities of the user

shareHolderslist of objects

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

directorslist of objects

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

associatedPartieslist of objects

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

businessPartnerslist of objects

Business partners of the company

transactionLimitsobject

Model for transaction limits for a given user

expectedTransactionCountriesobject

Model for expected transaction countries

expectedTransactionCurrenciesobject

Model for expected transaction currencies

riskLevelenum

kycRiskLevelenum

allowedPaymentMethodslist of enums

linkedEntitiesobject

acquisitionChannelenum

Model for User acquisition channel

savedPaymentDetailslist of objects

mccDetailsobject

tagslist of objects

Additional information that can be added via tags

attachmentslist of objects

User's attachments uploaded by business user

metaDataobject

Model for device data

jurisdictionstring

Legal authority or region governing the transaction

productsEnabledlist of objects

pepStatuslist of objects

sanctionsStatusboolean

Whether the user is sanctioned

adverseMediaStatusboolean

Whether the user is in the adverse media list

externalLinkslist of strings

External links related to the business user

executedRuleslist of objects

hitRuleslist of objects

riskScoreDetailsobject

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

$	curl https://sandbox.api.flagright.com/business/users/userId \
>	-H "x-api-key: <apiKey>"