Other/API Reference - Ideal Postcodes

Create

v1.0.0

Create a licensee for the specified API Key.

Input

{
  "type": "object",
  "properties": {
    "address": {
      "type": "string",
      "description": "Licensee's first, second and third line address as well as post town concatenated by commas"
    },
    "daily": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "number",
          "format": "int32",
          "description": "The maximum number of lookups this licensee can perform in a day. `null` indicates the limit is not active"
        }
      }
    },
    "key": {
      "type": "string",
      "description": "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
    },
    "name": {
      "type": "string",
      "description": "Licensee individual or organisation name"
    },
    "postcode": {
      "type": "string",
      "description": "Licensee's postcode"
    },
    "user_token": {
      "type": "string",
      "description": "A secret key used for sensitive operations on your account and API Keys.\n\nYour user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account).\n\nTypically beings `uk_...`\n"
    },
    "whitelist": {
      "type": "array",
      "description": "A list of allowed URLs. An empty list means that whitelisting is disabled",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "code",
    "message",
    "result"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        2000
      ]
    },
    "message": {
      "type": "string",
      "enum": [
        "Success"
      ]
    },
    "result": {
      "type": "object"
    }
  }
}