Sign in
latestOpenAPI 3.0.32026-08-084947174.1 KB

f9302ec2ef8a

Licenses

List Licenses

get/licenses

Query parameters

filter[license_holder_type]'company' | 'individual'

Filter licenses by license holder type. Value can be either company or individual.

filter[company_id]string uuid

Filter the collection by the specific Company UUID. Value MUST be a canonical UUID string (8-4-4-4-12). Example: 123e4567-e89b-12d3-a456-426614174000.

includestring[]

Comma-separated list of related resources to include for licenses.

limitinteger

Maximum number of results per page

pageinteger

Page number to retrieve

Response

Success

has_moreboolean

Indicates if there are more results available beyond the current page.

Example response

{
  "data": [
    {
      "account": {
        "billing_address": {
          "administrative_area": {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "country": {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      },
      "company": {
        "domicile": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "principal_address": {
          "administrative_area": {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "country": {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "mailing_address": {
          "administrative_area": {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "country": {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      },
      "ref_jurisdiction": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}