Tax forms

Retrieve a tax-form status

Scope: read

get/v1/tax_form_statuses/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/tax_form_statuses/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (tax_…)

Example:tax_7uSyy9FqVLCFWrdPeZaK

Query parameters

string
OR
string[]
string
OR
string[]

Response

The status

idstring required

Prefixed id (tax_…)

object'tax_form_status' required
partner_idstring required

Prefixed id (part_…)

type'w9' | 'w8ben' | 'w8bene' required
status'not_required' | 'required' | 'submitted' | 'expired' | 'superseded' required
entity_typestring nullable required
country_codestring nullable required
signed_atstring date-time nullable required

ISO-8601, UTC

expires_atstring date-time nullable required

ISO-8601, UTC

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "tax_7uSyy9FqVLCFWrdPeZaK",
  "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
  "signed_at": "2026-08-21T10:15:30.000Z",
  "expires_at": "2026-08-21T10:15:30.000Z",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.