Licensees

Create

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

post/keys/{key}/licensees

Request

  • Base URL: https://api.addresszen.com/v1
  • URL: https://api.addresszen.com/v1/keys/{key}/licensees
  • Auth: HTTP bearer

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

user_tokenstring

Management Key

A secret key used to manage your account and API Keys. It was previously called the user token.

Your management key can be retrieved and managed from your accounts page.

Typically begins uk_.... Prefer the Authorization: Bearer uk_... header.

Request body

namestring

Licensee individual or organisation name

addressstring

Licensee's first, second and third line address as well as post town concatenated by commas

postcodestring

Licensee's postcode

whiteliststring[]

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

Example request

{
  "name": "Qwerty Widgets Limited",
  "address": "12 High Street, Manchester",
  "postcode": "BR8 7RE",
  "whitelist": [
    "https://www.example.com"
  ],
  "daily": {
    "limit": 10000
  }
}

Response

Success

code2000 required
message'Success' required

Example response

{
  "result": {
    "name": "Qwerty Widgets Limited",
    "address": "12 High Street, Manchester",
    "postcode": "BR8 7RE",
    "whitelist": [
      "https://www.example.com"
    ],
    "daily": {
      "limit": 10000,
      "count": 232,
      "updatedAt": "2016-08-05T16:43:28.865Z"
    },
    "id": "56a11209ebe230380bf104c3",
    "key": "sl_ijoiqsxeQgXW2gkiE0X94",
    "createdAt": "2016-01-21T17:14:49.971Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.