DevKeyResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/acuris-geo-com/json-schema/acuris-geo-com-dev-key-response-schema.json",
  "title": "DevKeyResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/acuris-geo-com-openapi.json#/components/schemas/DevKeyResponse",
  "type": "object",
  "required": [
    "api_key",
    "validation_credits",
    "geocode_credits",
    "phone_credits",
    "expires_at",
    "tier",
    "info_url",
    "next_steps"
  ],
  "properties": {
    "api_key": {
      "type": "string",
      "description": "The evaluation key. Send it as `X-Acuris-Key: <key>` (or `Authorization: Bearer` / `X-API-Key` / `?key=`) on validation/geocoding calls."
    },
    "validation_credits": {
      "type": "integer",
      "description": "Lookups on the key. For an evaluation key (`trial_model: \"evaluation\"`) this is the ONE shared allowance for validation and geocoding."
    },
    "geocode_credits": {
      "type": "integer",
      "description": "Separate geocode pool; 0 for an evaluation key (geocoding draws on validation_credits)."
    },
    "phone_credits": {
      "type": "integer",
      "description": "Offline phone-validation pool seeded on the key."
    },
    "expires_at": {
      "type": "string",
      "description": "Expiry timestamp (UTC), 30 days from issuance for an evaluation key."
    },
    "tier": {
      "type": "string"
    },
    "info_url": {
      "type": "string",
      "description": "Pricing / info page (UK-specific for a `gbr` country hint)."
    },
    "next_steps": {
      "type": "string",
      "description": "Short onboarding note (how to use the key, link to plans)."
    },
    "trial_days": {
      "type": "integer",
      "description": "Length of the evaluation in days."
    },
    "trial_model": {
      "type": [
        "string",
        "null"
      ],
      "description": "\"evaluation\" when the key is a free evaluation key."
    },
    "shared_pool": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "True when validation and geocoding share validation_credits."
    },
    "uk_evaluation_total": {
      "type": [
        "integer",
        "null"
      ],
      "description": "UK (Royal Mail PAF) lookups included in the evaluation, counted separately from the 1,000."
    },
    "paf_note": {
      "type": [
        "string",
        "null"
      ],
      "description": "Present only when the request `country` hint is `gbr` — notes that UK addresses (Royal Mail PAF) are evaluation-only under a dev key."
    },
    "uk_evaluation_expires_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Present only when the request sent `\"accept_terms\": true` — end of the key's free UK evaluation (UTC)."
    }
  }
}