screen_numbers
Screen UK numbers (TPS and CTPS)
Screen UK phone numbers against the TPS and CTPS registers before calling. Each result is clean, tps-listed, ctps-listed, unknown, suppressed or consented. Draws the account's prepaid UK credits, one per distinct valid number; a test API key (tpsc_test_) returns fixtures at no cost. Same as POST /v1/screen.
输入参数campaign_refphone_numbers必填
wash_au_numbers
Wash Australian numbers (Do Not Call Register)
Wash Australian phone numbers against the Do Not Call Register. Needs a live account (an OAuth sign-in or a tpsc_live_ key), as 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.
输入参数phone_numbers必填
check_dead_numbers
Check whether mobiles are live (HLR)
Live mobile network (HLR) lookups: whether each mobile is live, switched off or dead. Needs a live account (an OAuth sign-in or a tpsc_live_ key). 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.
输入参数phone_numbers必填
get_account
Account and balances
The connected account and the key it acts as: 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.
无需输入参数。
set_company_name
Set the client business name
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.
输入参数company_name必填
buy_credits
Get a payment link for a prepaid pack
Creates a Stripe Checkout payment link for a prepaid pack on the connected account and returns the URL. Nothing is charged by this tool: a person opens the link and pays by card, and the credits land on the account once paid. Needs a live, 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-5k: TPSClear UK API credits (5,000 checks), £24.00 ex VAT; pack-10k: TPSClear UK API credits (10,000 checks), £39.00 ex VAT; pack-50k: TPSClear UK API credits (50,000 checks), £149.00 ex VAT; pack-100k: TPSClear UK API credits (100,000 checks), £199.00 ex VAT; pack-500k: TPSClear UK API credits (500,000 checks), £599.00 ex VAT; pack-1m: TPSClear UK API credits (1,000,000 checks), £799.00 ex VAT; pack-5m: TPSClear UK API credits (5,000,000 checks), £2499.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.
输入参数pack必填