API

Every veriphone.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.

Coverage

coverage

coverage List countries where Current (mode=current) lookups are available Risk: read

await corsair.veriphone.api.coverage({});

Input: empty object Output

Name	Type	Required	Description
`countries`	`object[]`	Yes	—
`updatedAt`	`string`	No	—

countries full type

{
  iso: string,
  covered: boolean
}[]

Credits

credits

credits Get the account credit balance and usage by lookup mode Risk: read

await corsair.veriphone.api.credits({});

Input: empty object Output

Name	Type	Required	Description
`email`	`string`	Yes	—
`counter`	`number`	Yes	—
`active`	`boolean`	Yes	—
`payg`	`number`	Yes	—
`limit`	`number`	Yes	—
`plan`	`string`	Yes	—
`renew`	`number`	Yes	—
`last_reset`	`object`	No	—
`usage`	`object`	No	—

last_reset full type

string | {
  seconds: number,
  nanos: number
}

usage full type

{
  static?: {
    count: number,
    credits: number
  },
  current?: {
    count: number,
    credits: number
  }
}

Get Example Phone Number

getExamplePhoneNumber

getExamplePhoneNumber Tool to retrieve an example phone number for a specified country and type. Use after confirming the country code. Example: ‘Get an example mobile number for US’. Risk: read

await corsair.veriphone.api.getExamplePhoneNumber({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO 3166-1 alpha-2 country code, e.g. US. Confirm it before calling.
`type`	`mobile \| fixed_line \| toll_free \| premium_rate \| shared_cost \| voip`	No	Example number line type. Defaults to mobile when omitted.

Output

Name	Type	Required	Description
`status`	`success \| error`	Yes	—
`phone_type`	`string`	Yes	—
`country_code`	`string`	Yes	—
`country_prefix`	`string`	No	—
`international_number`	`string`	No	—
`local_number`	`string`	No	—
`e164`	`string`	No	—
`E164`	`string`	No	—

Verify Phone Number

verifyPhoneNumber

verifyPhoneNumber Tool to verify if a phone number is valid. Use when you need to confirm formatting, region, and carrier details. Risk: write

await corsair.veriphone.api.verifyPhoneNumber({});

Input

Name	Type	Required	Description
`phone`	`string`	Yes	Phone number to verify. International E.164 format recommended.
`default_country`	`string`	No	ISO 3166-1 alpha-2 country code used when the number has no international prefix.
`mode`	`static \| current`	No	static (default, 1 credit) or current (live registry lookup, 10 credits).
`record`	`boolean`	No	true to save the result to the account verification history.

Output

Name	Type	Required	Description
`status`	`success \| error \| syntax-error`	Yes	—
`phone_valid`	`boolean`	Yes	—
`phone`	`string`	No	—
`reason`	`too_short \| too_long \| invalid_length \| invalid_country_code \| unrecognized_range \| not_a_number`	No	—
`phone_type`	`mobile \| fixed_line \| fixed_line_or_mobile \| toll_free \| premium_rate \| shared_cost \| voip \| short_code \| emergency \| unknown`	No	—
`shortcode_cost`	`toll_free \| standard_rate \| premium_rate \| unknown`	No	—
`carrier`	`string`	No	—
`phone_region`	`string`	No	—
`country`	`string`	No	—
`country_code`	`string`	No	—
`country_prefix`	`string`	No	—
`international_number`	`string`	No	—
`local_number`	`string`	No	—
`e164`	`string`	No	—
`timezone`	`string[]`	No	—
`geographical`	`boolean`	No	—
`mode`	`string`	No	—
`original_carrier`	`string`	No	—
`original_line_type`	`string`	No	—
`original_mccmnc`	`string`	No	—
`current_carrier`	`string`	No	—
`current_line_type`	`string`	No	—
`current_mccmnc`	`string`	No	—
`current_lookup`	`string`	No	—
`ported`	`boolean`	No	—
`carrier_data_source`	`string`	No	—

Overview

Plugins

Coverage

coverage

Credits

credits

Get Example Phone Number

getExamplePhoneNumber

Verify Phone Number

verifyPhoneNumber

​Coverage

​coverage

​Credits

​credits

​Get Example Phone Number

​getExamplePhoneNumber

​Verify Phone Number

​verifyPhoneNumber

Coverage

coverage

Credits

credits

Get Example Phone Number

getExamplePhoneNumber

Verify Phone Number

verifyPhoneNumber