List tin
Reads a payee's TIN in full — and, for a payee on a W-8, its foreign TIN, which the payer's Form 1042-S carries.
GET /v1/tax/w9/{id}/tin
| Address | https://api.hanzo.ai/v1/tax/w9/{id}/tin |
| Method | GET |
| Operation | get_tax_w9_by_id_tin |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reads a payee's TIN in full — and, for a payee on a W-8, its foreign TIN, which the payer's Form 1042-S carries. Only an org admin of the PAYER, only while the payee's grant is live, and every read is on the audit trail before a number is answered — a read the trail cannot record is refused.
This is the one place a TIN leaves the platform in full, apart from the IRS filing export. SuperAdmin is not admitted: platform authority is not a reason to read a company's TIN.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the relationship's id, "w9_"-prefixed. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | tax.tinOut | ok |
default | problem-details | refused |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
foreignTin | body | string | — | ForeignTIN is a W-8 payee's foreign tax identifying number as issued, which Form 1042-S carries for a foreign recipient. |
tin | body | string | — | TIN is the payee's full U.S. taxpayer identification number, hyphenated as the IRS writes it; empty when a W-8 carries none. |
tinType | body | string | — | TINType is ssn or ein. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, TaxApi } from 'hanzoai';
const api = new TaxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTaxW9ByIdTin({ id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TaxApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TaxApi(client).get_tax_w9_by_id_tin(id='id')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.TaxAPI.GetTaxW9ByIdTin(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, tax_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = tax_api::get_tax_w9_by_id_tin(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TaxApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new TaxApi(client).getTaxW9ByIdTin();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/tax/w9/<id>/tin \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for tax — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?