API

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

Account

account.balance Fetch the remaining DocuPost account balance Risk: read

await corsair.docupost.api.account.balance({});

Input: empty object Output

Name	Type	Required	Description
`balance`	`any`	No	—

send.letter Send a physical letter through DocuPost Risk: write

await corsair.docupost.api.send.letter({});

Input

Name	Type	Required	Description
`to_name`	`string`	Yes	—
`to_address`	`string`	Yes	—
`to_city`	`string`	Yes	—
`to_state`	`string`	Yes	—
`to_zip`	`string`	Yes	—
`from_name`	`string`	Yes	—
`from_address`	`string`	Yes	—
`from_city`	`string`	Yes	—
`from_state`	`string`	Yes	—
`from_zip`	`string`	Yes	—
`pdf_url`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`status`	`string`	No	—

send.postcard Send a physical postcard through DocuPost Risk: write

await corsair.docupost.api.send.postcard({});

Input

Name	Type	Required	Description
`to_name`	`string`	Yes	—
`to_address`	`string`	Yes	—
`to_city`	`string`	Yes	—
`to_state`	`string`	Yes	—
`to_zip`	`string`	Yes	—
`from_name`	`string`	Yes	—
`from_address`	`string`	Yes	—
`from_city`	`string`	Yes	—
`from_state`	`string`	Yes	—
`from_zip`	`string`	Yes	—
`front_image_url`	`string`	Yes	—
`back_image_url`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`status`	`string`	No	—