TPSClear

Screen UK phone numbers against the TPS and CTPS registers before calling. Each result is clean, tps-listed, ctps-listed, unknown, suppressed or consented. A live key draws prepaid UK credits (one per distinct valid number); a test key returns fixtures at no cost. Same as POST /v1/screen.

{
  "type": "object",
  "properties": {
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 40
      },
      "minItems": 1,
      "maxItems": 1000,
      "description": "Phone numbers, up to 1,000 per call, for example \"+447700900123\"."
    },
    "campaign_ref": {
      "type": "string",
      "maxLength": 120,
      "description": "Optional reference stored on the audit record: letters, digits, spaces and . , : / # _ - only."
    }
  },
  "required": [
    "phone_numbers"
  ],
  "additionalProperties": false
}

Wash Australian phone numbers against the Do Not Call Register. Live key only (the register has no test mode). One prepaid AU wash per distinct valid number; invalid numbers cost nothing and numbers the register gave no answer for are refunded. Same as POST /v1/dncr.

{
  "type": "object",
  "properties": {
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 40
      },
      "minItems": 1,
      "maxItems": 500,
      "description": "Phone numbers, up to 500 per call, for example \"+61412345678\"."
    }
  },
  "required": [
    "phone_numbers"
  ],
  "additionalProperties": false
}

Live mobile network (HLR) lookups: whether each mobile is live, switched off or dead. Live key only. One prepaid dead number check per mobile, two for a US number; numbers that are not mobiles and invalid numbers cost nothing. Same as POST /v1/dead-number.

{
  "type": "object",
  "properties": {
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 40
      },
      "minItems": 1,
      "maxItems": 500,
      "description": "Phone numbers, up to 500 per call, for example \"+447700900123\"."
    }
  },
  "required": [
    "phone_numbers"
  ],
  "additionalProperties": false
}

The calling key and its account: environment, scopes, company name and whether one is still required (GET /v1/me), plus the UK credits left (GET /v1/usage), the Australian washes left (GET /v1/dncr) and the dead number checks left (GET /v1/dead-number). A balance the key lacks the scope for comes back as that error. Costs nothing.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Set the legal name of the business this account screens numbers for (PATCH /v1/me). Required before a live key can screen. Voll Studios Ltd, the company behind TPSClear, is licensed by the DMA as a TPS and CTPS list cleaner. The licence requires a monthly declaration naming each client, so a live API key must belong to an account that names the business it screens numbers for.

{
  "type": "object",
  "properties": {
    "company_name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 160,
      "description": "The legal name of the client business, for example \"Acme Outbound Ltd\"."
    }
  },
  "required": [
    "company_name"
  ],
  "additionalProperties": false
}

Returns a Stripe Checkout URL for a prepaid pack, bound to this key's account. A person pays it by card; the credits land on the account once paid, and nothing is charged until then. Needs a live key on a self-serve account that names its client business. Prices are in minor units in the response. Packs: pack-1k: TPSClear UK API credits (1,000 checks), £9.00 ex VAT; pack-10k: TPSClear UK API credits (10,000 checks), £49.00 ex VAT; pack-50k: TPSClear UK API credits (50,000 checks), £179.00 ex VAT; au_100: TPSClear Australian DNCR washes (100), A$4.00 ex VAT; au_250: TPSClear Australian DNCR washes (250), A$9.00 ex VAT; au_500: TPSClear Australian DNCR washes (500), A$14.00 ex VAT; au_1000: TPSClear Australian DNCR washes (1,000), A$24.00 ex VAT; au_2500: TPSClear Australian DNCR washes (2,500), A$48.00 ex VAT; au_5000: TPSClear Australian DNCR washes (5,000), A$85.00 ex VAT; au_10000: TPSClear Australian DNCR washes (10,000), A$145.00 ex VAT; au_25000: TPSClear Australian DNCR washes (25,000), A$310.00 ex VAT; au_50000: TPSClear Australian DNCR washes (50,000), A$600.00 ex VAT; au_100000: TPSClear Australian DNCR washes (100,000), A$1170.00 ex VAT; dn_100: TPSClear dead number checks (100), £1.00 ex VAT; dn_250: TPSClear dead number checks (250), £2.50 ex VAT; dn_500: TPSClear dead number checks (500), £5.00 ex VAT.

{
  "type": "object",
  "properties": {
    "pack": {
      "type": "string",
      "enum": [
        "pack-1k",
        "pack-10k",
        "pack-50k",
        "au_100",
        "au_250",
        "au_500",
        "au_1000",
        "au_2500",
        "au_5000",
        "au_10000",
        "au_25000",
        "au_50000",
        "au_100000",
        "dn_100",
        "dn_250",
        "dn_500"
      ],
      "description": "The pack id."
    }
  },
  "required": [
    "pack"
  ],
  "additionalProperties": false
}