v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Account

Account:Licenses

Returns all merchants that you have access to

get/v2/accounts/me/licenses

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

Response

codestring

addressRequiredboolean

if one of the licenses is an ubo ir is authorized to sign, then the address is required, so return true otherwise false

Example response

{
  "code": "A-1234-4321",
  "addressRequired": true,
  "globalAuthorisations": {
    "canMerchantImitate": true,
    "canAccountImitate": true
  },
  "licenses": [
    {
      "code": "AL-1234-4321",
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "icon": "base64-data",
        "status": "ACTIVE"
      },
      "complianceData": {
        "authorizedToSign": "shared",
        "uboPercentage": 15,
        "ubo": "direct"
      },
      "notificationGroup": {
        "financial": true
      },
      "platform": {
        "loginAccount": true,
        "authorisation": "all",
        "authorisationGroups": []
      },
      "roles": {
        "primaryContactPerson": true,
        "internalAdministrator": true
      },
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedBy": "AT-1233-1322"
    }
  ]
}