Create a tax form
Gateway module
POST/tax-formstaxForms.create
A tax form. Restricted and encrypted; only the last four digits of the identifier are ever displayed. Creates a tax form. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability me.work_details.write.
- OAuth scopes: me.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: TaxFormCreate
| Field | Type | Required | Description |
|---|---|---|---|
| foreign_performer_withholding | boolean | No | Foreign performer withholding flag. |
| organization_id | string (uuid) | null | No | Identifier of the payee external account. |
| form_kind | "W-9" | "W-8BEN" | "W-8BEN-E" | Yes | Tax form. |
| tax_identifier | string | Yes | Tax identifier. Write-only: it is encrypted and never returned.Constraints: length 4 to 64 |
{
"foreign_performer_withholding": false,
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"form_kind": "W-9",
"tax_identifier": "123456789"
}Response 201: TaxForm
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the tax form. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| tin_last4 | string | Yes | Last four digits of the tax identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| foreign_performer_withholding | boolean | Yes | Foreign performer withholding flag. |
| person_id | string (uuid) | null | Yes | Identifier of the payee person, set from the session. |
| organization_id | string (uuid) | null | Yes | Identifier of the payee external account. |
| form_kind | "W-9" | "W-8BEN" | "W-8BEN-E" | Yes | Tax form. |
| signed_at | string (date-time) | Yes | When the payee signed the form, set by the database. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"tin_last4": "6789",
"foreign_performer_withholding": false,
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"form_kind": "W-9",
"signed_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/tax-forms" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"foreign_performer_withholding":false,"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","form_kind":"W-9","tax_identifier":"123456789"}'const { data } = await xos.taxForms.create({
"foreign_performer_withholding": false,
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"form_kind": "W-9",
"tax_identifier": "123456789"
});response = xos.tax_forms.create({"foreign_performer_withholding": False, "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "form_kind": "W-9", "tax_identifier": "123456789"})xos tax-forms create --data '{"foreign_performer_withholding":false,"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","form_kind":"W-9","tax_identifier":"123456789"}'