---
title: "Create"
method: POST
path: "/keys/{key}/licensees"
tags: ["Licensees"]
---

# Create

`POST /keys/{key}/licensees`

Create a licensee for the specified API Key.

## Path parameters

- `key` string, required

## Query parameters

- `user_token` string

## Request body

- LicenseeEditable — Licensee object which can be defined by user
  - `name` string — Licensee individual or organisation name
  - `address` string — Licensee's first, second and third line address as well as post town concatenated by commas
  - `postcode` string — Licensee's postcode
  - `whitelist` string[] — A list of allowed URLs. An empty list means that whitelisting is disabled
  - `daily` object
    - `limit` number, nullable — The maximum number of lookups this licensee can perform in a day. `null` indicates the limit is not active

## Response `200`

Success

- LicenseeResponse
  - `result` Licensee, required — Licensee object which can be defined by user
    - `name` string, required — Licensee individual or organisation name
    - `address` string, required — Licensee's first, second and third line address as well as post town concatenated by commas
    - `postcode` string, required — Licensee's postcode
    - `whitelist` string[], required — A list of allowed URLs. An empty list means that whitelisting is disabled
    - `daily` object, required
      - `limit` number, nullable — The maximum number of lookups this licensee can perform in a day. `null` indicates the limit is not active
      - `count` number, required — The number lookups performed by the licensee on the day represented b `licesees.daily.updatedAt`
      - `updatedAt` string, required — The timestamp when the limit was last used.
    - `id` string, required — An immutable ID provided for every licensee. Primarily used for paginated list requests.
    - `key` string, required — Uniquely identifies a licensee for a key. Required to perform paid lookups for a specific licensee. Typically begins `sk_`.
    - `createdAt` string, required — Timestamp for when the licensee was created
  - `code` 2000, required
  - `message` 'Success', required

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/ideal-postcodes/apis/api-reference.md) · [All operations](https://skmtc.net/ideal-postcodes/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideal-postcodes/api-reference/revisions/295dd3238f22/schema)