E-File Magic

W-9 requests

Cancel a W-9 request

Cancel a W-9 request when its current state allows cancellation.

POST
/api/v1/w9/requests/cancel
Authentication
OAuth 2.0 access token
Required scopes
w9.writew9.cancel
Idempotency key
Required
Rate-limit cost
5 units

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

35 fields
account_refMay be omittedstring | null

Maximum characters: 512.

business_nameMay be omittedstring | null

Maximum characters: 512.

canceled_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

converted_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

converted_filer_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

converted_recipient_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

created_atAlways returnedstring (date-time)

Type: string (date-time).

dispatched_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

emailAlways returnedstring | null

Maximum characters: 512.

entity_type_cdMay be omittedstring | null

Maximum characters: 512.

issuer_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

issuer_snapshotMay be omittedobject | null

Type: object | null.

Complete response schema: ApiV1W9Request

Structure · HTTP 200
{
  "data": {
    "account_ref": "string | null",
    "business_name": "string | null",
    "canceled_at": "string (date-time) | null",
    "converted_at": "string (date-time) | null",
    "converted_filer_id": "string (uuid) | null",
    "converted_recipient_id": "string (uuid) | null",
    "created_at": "string (date-time)",
    "dispatched_at": "string (date-time) | null",
    "email": "string | null",
    "entity_type_cd": "string | null",
    "issuer_id": "string (uuid) | null",
    "issuer_snapshot": "object | null",
    "opened_at": "string (date-time) | null",
    "person_first_nm": "string | null",
    "person_last_nm": "string | null",
    "person_middle_nm": "string | null",
    "person_suffix_nm": "string | null",
    "prior_request_id": "string (uuid) | null",
    "purpose": "string | null",
    "recipient_name": "string | null",
    "reconfirmation_apply_status": "string | null",
    "reconfirmation_data": "object | null",
    "reconfirmation_review_reason": "string | null",
    "request_id": "string (uuid)",
    "source_recipient_version": "integer | null",
    "status": "string | null",
    "submitted_at": "string (date-time) | null",
    "submitted_data": "object | null",
    "target_filer_id": "string (uuid) | null",
    "target_recipient_id": "string (uuid) | null",
    "tax_classification": "string | null",
    "tin_last4": "string | null",
    "tin_type": "string | null",
    "updated_at": "string (date-time)",
    "version": "integer"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.