# tpsclear-co-uk API

**Canonical:** https://apis.io/apis/tpsclear-co-uk/tpsclear-co-uk-api/  
**Provider:** tpsclear-co-uk — https://apis.io/providers/tpsclear-co-uk/  
**Base URL:** https://api.tpsclear.co.uk  
**Documentation:** https://tpsclear.co.uk/articles/tps-register-api

tpsclear-co-uk API is one of 2 APIs that [tpsclear-co-uk](https://apis.io/providers/tpsclear-co-uk/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

tpsclear-co-uk API as documented publicly: 19 operations. Contract generated from the documentation by API Evangelist (2026-10-31); not the provider's own document.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/v1/consents` | Remove one number when consent is withdrawn. |
| GET | `/v1/consents` | Your consent list: numbers you hold consent to call. |
| POST | `/v1/consents` | Add numbers to the consent list with the same bodies and limits as POST /v1/suppressions. |
| GET | `/v1/dead-number` | The dead number checks left on your account. |
| POST | `/v1/dead-number` | Ask the mobile network whether up to 500 numbers are live, switched off or dead. |
| GET | `/v1/dncr` | Get the Australian Do Not Call Register washes remaining on your key. |
| POST | `/v1/dncr` | Screen an Australian phone number against ACMA's Do Not Call Register. |
| POST | `/v1/keys/rotate` | Mint a replacement token for the key and optionally revoke the old one. |
| GET | `/v1/me` | The calling key's name, environment, plan and scopes. |
| PATCH | `/v1/me` | PATCH /v1/me |
| POST | `/v1/screen` | Screen a single number or small batch of phone numbers against the TPS and CTPS registers. |
| POST | `/v1/screen/bulk` | Submit a bulk list of up to 50,000 phone numbers for screening against the TPS and CTPS registers. |
| GET | `/v1/screen/bulk/scr_01HYZ` | Retrieve the results of a bulk screening job. |
| GET | `/v1/screen/{id}` | Fetch a past screen result by id for audit purposes. |
| DELETE | `/v1/suppressions` | Remove one number from the suppression list. |
| GET | `/v1/suppressions` | Your own do-not-call list: the total count and the 100 most recent entries. |
| POST | `/v1/suppressions` | Add up to 10,000 numbers per request to the suppression list. |
| GET | `/v1/usage` | Current-window usage for the key plus rolling 30-day totals for the account. |
| POST | `/webhooks/tpsclear` | Webhook endpoint that receives re-screening notifications when a number's TPS or CTPS status changes. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/tpsclear-co-uk/openapi/_ae-authored/tpsclear-co-uk-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/tpsclear-co-uk/json-schema/tpsclear-co-uk-get-v1-screen-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tpsclear-co-uk/json-schema/tpsclear-co-uk-post-v1-suppressions-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tpsclear-co-uk/json-schema/tpsclear-co-uk-post-v1-consents-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tpsclear-co-uk/json-schema/tpsclear-co-uk-post-v1-screen-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/tpsclear-co-uk/json-schema/tpsclear-co-uk-post-webhooks-tpsclear-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/tpsclear-co-uk/json-schema/tpsclear-co-uk-get-v1-usage-response-schema.json

## Other tpsclear-co-uk APIs (1)

- [TPSClear API](https://apis.io/apis/tpsclear-co-uk/tpsclear-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/tpsclear-co-uk/tpsclear-co-uk-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/tpsclear-co-uk/.