v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB

Keys

Update Details

Update API Key Details

put/keys/{key}/details

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

user_tokenstring

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_...

Request body

namestring

A name for the key

allowed_urlsstring[]

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

redact_daysinteger

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

ip_forwardingboolean

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

Example request

{
  "name": "My API Key",
  "daily_limit": {
    "limit": 1000
  },
  "monthly_limit": {
    "limit": 10000
  },
  "individual_limit": {
    "limit": 30
  },
  "notifications": {
    "emails": [
      "person@example.com"
    ],
    "balance_threshold": 500
  },
  "datasets": {
    "usps": 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,
    "gnaf": true,
    "kadaster": true,
    "kartverket": true,
    "sdfi": true,
    "cannar": true,
    "fodbosa": true,
    "mois": true,
    "upujp": true,
    "bev": true,
    "gbrcleanse": true,
    "uspscleanse": true
  }
}

Response

Success

code2000 required

message'Success' required

Example response

{
  "result": {
    "name": "My API Key",
    "contexts": [
      {
        "iso_3": "USA",
        "iso_2": "US",
        "description": "United States",
        "emoji": "🇺🇸",
        "rgeo": true
      }
    ],
    "lookups_remaining": 19889,
    "daily_limit": {
      "limit": 1000,
      "consumed": 288
    },
    "monthly_limit": {
      "limit": 10000,
      "consumed": 2500
    },
    "individual_limit": {
      "limit": 30
    },
    "notifications": {
      "emails": [
        "person@example.com"
      ],
      "balance_threshold": 500
    },
    "datasets": {
      "paf": true,
      "mr": true,
      "usps": true,
      "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,
      "kartverket": true,
      "mois": true,
      "sdfi": true,
      "cannar": true,
      "fodbosa": true,
      "upujp": true,
      "bev": true,
      "gbrcleanse": true,
      "uspscleanse": true
    },
    "automated_topups": {
      "enabled": true
    },
    "current_purchases": [
      {
        "expires": "2022-01-06T11:41:27.092Z",
        "purchased": 20000,
        "consumed": 121
      }
    ]
  }
}