API

Every tpscheck.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Batch

post

batch.post Check multiple UK phone numbers against TPS and CTPS registers Risk: read

await corsair.tpscheck.api.batch.post({});

Input

Name	Type	Required	Description
`phones`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`total`	`number`	No	—
`results`	`object[]`	Yes	—

results full type

{
  input: string,
  e164?: string,
  valid: boolean,
  line?: {
    type?: string,
    original_carrier?: string,
    location?: string,
    country?: string,
    prefix?: string
  },
  reachability?: {
    status?: string,
    confidence?: string
  },
  tps?: boolean,
  ctps?: boolean,
  risk?: any
}[]

Check

post

check.post Check a UK phone number against TPS and CTPS registers Risk: read

await corsair.tpscheck.api.check.post({});

Input

Name	Type	Required	Description
`phone`	`string`	Yes	—

Output

Name	Type	Required	Description
`input`	`string`	Yes	—
`e164`	`string`	No	—
`valid`	`boolean`	Yes	—
`line`	`object`	No	—
`reachability`	`object`	No	—
`tps`	`boolean`	No	—
`ctps`	`boolean`	No	—
`risk`	`any`	No	—

line full type

{
  type?: string,
  original_carrier?: string,
  location?: string,
  country?: string,
  prefix?: string
}

reachability full type

{
  status?: string,
  confidence?: string
}

Credits

get

credits.get Get TPSCheck API usage and remaining credits Risk: read

await corsair.tpscheck.api.credits.get({});

Input: empty object Output

Name	Type	Required	Description
`requests_used`	`number`	Yes	—
`requests_remaining`	`number`	Yes	—
`monthly_limit`	`number`	Yes	—
`plan`	`string`	Yes	—
`reset_date`	`string`	Yes	—

Status

get

status.get Check TPSCheck API health and version Risk: read

await corsair.tpscheck.api.status.get({});

Input: empty object Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`version`	`string`	No	—

Overview

Plugins

Batch

post

Check

post

Credits

get

Status

get

​Batch

​post

​Check

​post

​Credits

​get

​Status

​get

Batch

post

Check

post

Credits

get

Status

get