Skip to main content

Update Details

PUT 

/keys/:key/details

Update API Key Details

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

Body

required
    daily_limit object
    limit int32nullable

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

    individual_limit object
    limit int32nullable

    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[]

    Possible values: <= 256 characters, Value must match regular expression ^[^\s]+$

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

    redact_days integer

    Possible values: <= 1095

    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 object
    emails string[]

    Possible values: Value must match regular expression ^\S{1,100}@\S{1,100}$

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

    enabled boolean

    Indicates whether email notifications are enabled.

    ip_forwarding boolean

    Default value: false

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

    datasets object

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

    pafa boolean

    UK Property Alias dataset

    pafw boolean

    UK Welsh Language Dataset

    usps boolean

    US Address Dataset

    hereap boolean

    Asia Pacific Address File

    herehk boolean

    Hong Kong Address File

    herei boolean

    India Address File

    herem boolean

    Macau Address File

    heremea boolean

    Middle East and Africa Address File

    heremeas boolean

    Middle East and Africa Extended File

    herena boolean

    North America Address File

    hereo boolean

    Oceania Address File

    heresa boolean

    South America Address File

    heret boolean

    Taiwan Address File

    hereee boolean

    Eastern Europe Address File

    herewe boolean

    Western Europe Address File

    phone boolean

    Phone validation is enabled

    email boolean

    Email validation is enabled

    gnaf boolean

    Australia Geoscape Geocoded National Address File

Responses

Success

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]

Loading...