Assessment21

Authorization1

Black Kite Bridge5

Company7

Company Digital Footprint23

Company Products3

Company Report4

Company Trend2

Compliance5

Cyber Threat Feed4

Ecosystem5

Financial Risk3

Findings40

Global Companies3

Groups1

Industry1

License4

Log2

Notification7

Permissions1

Profile1

Risk Intelligence13

Roles1

Security Controls1

Status1

Subsidiary Structure1

SupplyChain3

Tag7

Ticket2

User1

Widget9

Workflow2

License

Get a license defined for the tenant.

get/api/v2/licenses/{id}

Request

Base URL
https://app.blackkitetech.com
Auth
OAuth 2
Client credentials
Token URLhttps://app.blackkitetech.com//api/v2/oauth/token
TypeScript
https://skmtc.dev/blackkitetech/apis/black-kite-api/docs/api/v2/licenses/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The id of the license requested.

Response

Success

LicenseIdinteger required

Typestring

There are three license types; Continuous Annual, Continuous 60-day and AI Agent.

StartDatestring datetime

The date time the license starts.

EndDatestring datetime

The date time the license expires.

NumberOfRemainingEntitiesinteger nullable

The remaining valid entity count for this license.

NumberOfMaxEntitiesinteger nullable

The upper entity limit for this license.

RemainingSwapCountinteger

The number of remaining swap operations available for this license. A value of -1 indicates unlimited swaps.

TotalSwapCountinteger

The total number of swap operations permitted for this license. A value of -1 indicates unlimited swaps.

Example response

{
  "LicenseId": 213,
  "Type": "ContinuousAnnual",
  "StartDate": "2021-09-29T16:47:36.527Z",
  "EndDate": "2022-09-29T16:47:36.527Z",
  "NumberOfRemainingEntities": 7,
  "NumberOfMaxEntities": 20,
  "RemainingSwapCount": 3,
  "TotalSwapCount": 10
}

Changes

No recorded changes to this operation across all 8 revisions of this API.