Create

POST 
/keys/:key/licensees

Create a licensee for the specified API Key.

Request

Path Parameters

key stringrequired
API Key
The API Key to retrieve. Begins ak_.
Example: ak_test

Query Parameters

user_token string
Private User Token
A secret key used for sensitive operations on your account and API Keys.
Your user token can be retrieved and managed from your accounts page.
Typically beings uk_...
Example: uk_B59ScW1p1HHouf1VqclEPZUx

application/json

Body

required

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 int32nullable

The maximum number of lookups this licensee can perform in a day. null indicates the limit is not active

Responses

200

Success

application/json

Schema

Schema

result object

Licensee object which can be defined by user

name stringrequired

Licensee individual or organisation name

address stringrequired

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

postcode stringrequired

Licensee's postcode

whitelist string[]required

A list of allowed URLs. An empty list means that whitelisting is disabled

daily objectrequired

limit int32nullable

The maximum number of lookups this licensee can perform in a day. null indicates the limit is not active

count int32required

The number lookups performed by the licensee on the day represented b licesees.daily.updatedAt

updatedAt stringrequired

The timestamp when the limit was last used.

id stringrequired

An immutable ID provided for every licensee. Primarily used for paginated list requests.

key stringrequired

Uniquely identifies a licensee for a key.

Required to perform paid lookups for a specific licensee. Typically begins sk_.

createdAt stringrequired

Timestamp for when the licensee was created

code int32required

Possible values: [2000]

message stringrequired

Possible values: [Success]

Example (from schema)

{
  "result": {
    "name": "Qwerty Widgets Limited",
    "address": "12 High Street, Manchester",
    "postcode": "ID1 1QD",
    "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"
  },
  "code": 2000,
  "message": "Success"
}

400

Bad Request

application/json

Schema

Schema

code int32required

API Response Code. Non 2xxx code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.

message stringrequired

Human readable error message supplied with every error response.

errors object[]
Array [
message stringrequired
Indicates location of error in request query or URL parameter
path stringrequired
Indicates location of error in request query or URL parameter
errorCode string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    {
      "message": "should have required property 'type'",
      "path": ".query.type",
      "errorCode": "required.openapi.validation"
    }
  ]
}

Loading...