Details

GET 
/keys/:key/details

Returns private data on the key including remaining lookups, available datasets and usage limits.

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

Responses

200

Success

application/json

Schema

Schema

result objectrequired

lookups_remaining int32required

daily_limit objectrequired

limit int32nullablerequired

number or null. The daily lookup limit currently set on your key. null means the limit is currently disabled.

consumed int32required

Number of lookups performed today which count towards your daily limit.

individual_limit objectrequired

limit int32nullablerequired

number or null Limit set on the number of lookups that can be performed from a single IP address. null means the limit is currently disabled.

allowed_urls string[]required

A list of allowed URLs. An empty list means that allowed URLs are disabled.

redact_days integerrequired

Default value: 28

Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage

notifications objectrequired

emails string[]required

A list of email addresses designated by you to receive notifications about this key.

enabled booleanrequired

Indicates whether email notifications are enabled.

datasets objectrequired

Indicates which datasets are available and added by default to the address responses

paf booleanrequired

UK Main Address File (Postcode Address File)

pafa booleanrequired

UK Property Alias dataset

pafw booleanrequired

UK Welsh Language Dataset

mr booleanrequired

UK Multiple Residence Dataset

nyb booleanrequired

UK Not Yet Built Dataset

ab booleanrequired

UK AddressBase dataset

nip booleanrequired

Northern Ireland Pointer Dataset

usps booleanrequired

US Address Dataset

ecad booleanrequired

IE Address File. Eircode Address Database

ecaf booleanrequired

IE Base Address File. Eircode Address File

gnaf booleanrequired

Australia Geocoded National Address File

hereap booleanrequired

Asia Pacific Address File

herehk booleanrequired

Hong Kong Address File

herei booleanrequired

India Address File

herem booleanrequired

Macau Address File

heremea booleanrequired

Middle East and Africa Address File

heremeas booleanrequired

Middle East and Africa Standalone Intermediate Maps Address File

herena booleanrequired

North America Address File

hereo booleanrequired

Oceania Address File

heresa booleanrequired

South America Address File

heret booleanrequired

Taiwan Address File

hereee booleanrequired

Eastern Europe Address File

herewe booleanrequired

Western Europe Address File

phone booleanrequired

Phone validation is enabled

email booleanrequired

Email validation is enabled

automated_topups objectrequired

Automated topup status

enabled booleanrequired

Indicates whether automated top-ups are enabled

current_purchases object[]required

Current balance purchases attached to key.

Array [

expires stringnullablerequired

string or null The date when this purchase will expire in simplified extended ISO format (ISO 8601). This is typically 365 days from the time of first use. This field will be null if the purchase has not yet been used.

purchased int32required

Number of procured lookups from this purchase.

consumed int32required

Number of consumed lookups off this purchase.

]

ip_forwarding booleanrequired

Default value: false

Accept IP addresses forwarded in the IDPC-Source-IP header

code int32required

Possible values: [2000]

message stringrequired

Possible values: [Success]

Example (from schema)

{
  "result": {
    "lookups_remaining": 19889,
    "daily_limit": {
      "limit": 1000,
      "consumed": 288
    },
    "individual_limit": {
      "limit": 30
    },
    "allowed_urls": [
      "string"
    ],
    "redact_days": 28,
    "notifications": {
      "emails": [
        "person@example.com"
      ],
      "enabled": true
    },
    "datasets": {
      "paf": true,
      "pafa": false,
      "pafw": false,
      "mr": true,
      "nyb": false,
      "ab": false,
      "nip": false,
      "usps": true,
      "ecad": false,
      "ecaf": false,
      "gnaf": true,
      "hereap": true,
      "herehk": true,
      "herei": true,
      "herem": true,
      "heremea": true,
      "heremeas": true,
      "herena": true,
      "hereo": true,
      "heresa": true,
      "heret": true,
      "hereee": true,
      "herewe": true,
      "phone": true,
      "email": true
    },
    "automated_topups": {
      "enabled": true
    },
    "current_purchases": [
      {
        "expires": "2022-01-06T11:41:27.092Z",
        "purchased": 20000,
        "consumed": 121
      }
    ],
    "ip_forwarding": false
  },
  "code": 2000,
  "message": "Success"
}

401

Unauthorised

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.

Example (from schema)

{
  "code": 0,
  "message": "string"
}

404

Resource not found

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.

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...