E-File Magic

W-9 requests

Send W-9 requests

Queue W-9 collection links for delivery through the selected channel.

POST
/api/v1/w9/requests/dispatch
Authentication
OAuth 2.0 access token
Required scopes
w9.writew9.dispatch
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

2 fields
dispatchedAlways returnedarray<object>

Type: array<object>.

Nested fields (35)

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.

opened_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

person_first_nmMay be omittedstring | null

Maximum characters: 512.

person_last_nmMay be omittedstring | null

Maximum characters: 512.

person_middle_nmMay be omittedstring | null

Maximum characters: 512.

person_suffix_nmMay be omittedstring | null

Maximum characters: 512.

prior_request_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

purposeAlways returnedstring | null

Maximum characters: 512.

recipient_nameMay be omittedstring | null

Maximum characters: 512.

reconfirmation_apply_statusMay be omittedstring | null

Maximum characters: 512.

reconfirmation_dataMay be omittedobject | null

Tax identifier is masked according to route scope.

reconfirmation_review_reasonMay be omittedstring | null

Maximum characters: 512.

request_idAlways returnedstring (uuid)

Type: string (uuid).

source_recipient_versionMay be omittedinteger | null

Minimum: 1.

statusAlways returnedstring | null

Maximum characters: 512.

submitted_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

submitted_dataMay be omittedobject | null

Tax identifier is masked according to route scope.

target_filer_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

target_recipient_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

tax_classificationMay be omittedstring | null

Maximum characters: 512.

tin_last4May be omittedstring | null

Maximum characters: 512.

tin_typeMay be omittedstring | null

Maximum characters: 512.

updated_atAlways returnedstring (date-time)

Type: string (date-time).

versionAlways returnedinteger

Minimum: 1.

runAlways returnedobject

Type: object.

Complete response schema: ApiV1W9DispatchResponse

Structure · HTTP 200
{
  "data": {
    "dispatched": "array<object>",
    "run": "object"
  },
  "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.