API

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

Autocomplete

addresses

autocomplete.addresses Get address autocomplete suggestions for a partial address query Risk: read

await corsair.addresszen.api.autocomplete.addresses({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	Partial address string to autocomplete
`limit`	`number`	No	—
`page`	`number`	No	—

Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`message`	`string`	Yes	—
`result`	`object`	Yes	—

result full type

{
  hits: {
    id: string,
    suggestion: string,
    urls?: {
    } | null,
    udprn?: number
  }[]
}

Key

availability

key.availability Get public information on an API key, including whether it is currently usable Risk: read

await corsair.addresszen.api.key.availability({});

Input: empty object Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`message`	`string`	Yes	—
`result`	`object`	Yes	—

result full type

{
  available: boolean,
  context?: string,
  contexts?: {
  }[]
}

Resolve

addressUsa

resolve.addressUsa Resolve an address autocompletion by its address ID and return the full address in US format Risk: read

await corsair.addresszen.api.resolve.addressUsa({});

Input

Name	Type	Required	Description
`addressId`	`string`	Yes	Address suggestion ID from autocomplete (e.g. usps_X130125796\|1600\|\|1933)

Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`message`	`string`	Yes	—
`result`	`object`	Yes	—

result full type

{
  id?: string,
  line_1?: string,
  line_2?: string,
  city?: string,
  state?: string,
  state_abbreviation?: string,
  zip_code?: string,
  country_iso_2?: string
}

Verify

address

verify.address Verify and standardize a US address using USPS CASS validation Risk: read

await corsair.addresszen.api.verify.address({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	Address to verify. Use a full free-form address, or only the first line when city/state or zip_code are provided separately.
`zip_code`	`string`	No	—
`city`	`string`	No	—
`state`	`string`	No	—
`context`	`string`	No	Optional metadata tag stored with the lookup

Output

Name	Type	Required	Description
`code`	`number`	Yes	—
`message`	`string`	Yes	—
`result`	`object`	Yes	—

result full type

{
  query: string,
  query_city?: string,
  query_state?: string,
  query_zip_code?: string,
  match?: any | null,
  count?: number,
  fit?: number,
  confidence?: number,
  match_information?: any,
  address_line_one?: string,
  address_line_two?: string,
  city?: string,
  state?: string,
  zip_code?: string,
  country_iso_2?: string
}

Overview

Plugins

Autocomplete

addresses

Key

availability

Resolve

addressUsa

Verify

address

​Autocomplete

​addresses

​Key

​availability

​Resolve

​addressUsa

​Verify

​address

Autocomplete

addresses

Key

availability

Resolve

addressUsa

Verify

address