E-File Magic

W-9 requests

Upload a W-9 request list

Create a W-9 import and get upload instructions for its spreadsheet.

POST
/api/v1/w9/imports/create_upload
Authentication
OAuth 2.0 access token
Required scopes
w9.write
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

4 fields
submissionAlways returnedobject

Unknown fields are rejected.

Nested fields (20)

content_typeMay be omittedstring | null

Type: string | null.

created_atAlways returnedstring (date-time)

Type: string (date-time).

created_byAlways returnedobject

Type: object.

created_by_user_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

dispatch_requestedAlways returnedboolean

Type: boolean.

dispatched_countAlways returnedinteger

Minimum: 0.

file_nameAlways returnedstring

Type: string.

issuer_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

notify_emailMay be omittedstring (email) | null

Type: string (email) | null.

request_count_createdAlways returnedinteger

Minimum: 0.

row_count_processedAlways returnedinteger

Minimum: 0.

row_count_totalAlways returnedinteger

Minimum: 0.

rows_per_chunkAlways returnedinteger

Minimum: 1.

size_bytesMay be omittedinteger | null

Minimum: 0.

skipped_countAlways returnedinteger

Minimum: 0.

source_stage_completedAlways returnedboolean

Type: boolean.

statusAlways returnedstring

Type: string.

submission_idAlways returnedstring (uuid)

Type: string (uuid).

updated_atAlways returnedstring (date-time)

Type: string (date-time).

versionAlways returnedinteger

Minimum: 1.

upload_headersAlways returnedobject

Additional values: string.

upload_methodAlways returned"PUT"

Value: "PUT".

upload_urlAlways returnedstring (uri)

Type: string (uri).

Complete response schema: ApiV1W9ImportCreateUploadResponse

Structure · HTTP 200
{
  "data": {
    "submission": "object",
    "upload_headers": "object",
    "upload_method": "\"PUT\"",
    "upload_url": "string (uri)"
  },
  "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.