create_licensee

Create

Creates a licensee on a key and returns it with its generated sl_ key. The key must be enabled for sublicensing.

Endpoint

POST /keys/{key}/licensees

See the API reference for this endpoint.

This operation needs a Management Key. Pass it as the required user_token keyword argument; the client sends it in the Authorization header. See setup.

Import

from ideal_postcodes import IdealPostcodes

Call create_licensee on the IdealPostcodes client. Path parameters are positional; query and body parameters are keyword-only.

Path Parameters

Name	Type	Required	Description
key	str	yes	API Key The API Key to retrieve. Begins ak_.

Query Parameters

None.

Request Body

Name	Type	Required	Description
name	str	no	Licensee individual or organisation name
address	str	no	Licensee's first, second and third line address as well as post town concatenated by commas
postcode	str	no	Licensee's postcode
whitelist	list[str]	no	A list of allowed URLs. An empty list disables the check. A request is allowed when its Origin or Referer header matches an entry. Use one of these formats: - https://www.example.com allows one site. Scheme and host must match - *.example.com allows the domain and all its subdomains
daily	requests.CreateLicenseeDaily	no

Nested settings are typed dictionaries from ideal_postcodes.requests.

class CreateLicenseeDaily(TypedDict):
    limit: NotRequired[float | None]

Response Type

from ideal_postcodes.types import CreateLicenseeResult

Errors

Unsuccessful HTTP responses raise APIError or a subclass, with the HTTP status and the API error code and message. Connection failures and timeouts raise TransportError. Unexpected responses raise ProtocolError. All derive from ClientError. See error handling.

Example

create_licensee.pypython

from ideal_postcodes import IdealPostcodes

with IdealPostcodes("ak_test") as client:
    licensee = client.create_licensee("ak_test", user_token="uk_example", name="Example Company")