W-9 requests
Start a W-9 import
Process the uploaded W-9 request list.
/api/v1/w9/imports/start- Authentication
- OAuth 2.0 access token
- Required scopes
w9.write- Idempotency key
- Required
- Rate-limit cost
- 5 units
How to use this endpoint
Inspect the file and resolve its mapping first. Creating requests requires purchased W-9 capacity. Read the import and row results to check what was created.
Retrying a request? Keep the same idempotency key and body after an uncertain result. A different key can repeat the action.
curl --request POST 'https://api.efilemagic.com/api/v1/w9/imports/start' \
--header 'Authorization: Bearer <access-token>' \
--header 'Idempotency-Key: <unique-operation-key>' \
--header 'Content-Type: application/json' \
--data-binary @request.jsonReplace placeholders with your own values. Use the API resource origin provided for your environment.
Create request.json using the documented fields. Field descriptions are not sample values.
Request fields
2 fieldssubmission_idRequiredstring (uuid)
Import submission ID returned when the import was created.
expected_versionOptionalinteger | null
Version from the latest read of the record. A changed version requires review before updating. Minimum: 1.
Headers (3)
AuthorizationRequired- OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
Idempotency-KeyRequired- Opaque caller-generated key bound to resolved tenant, connection, and actor scope.
DPoPConditional / optional- Required when the application, connection, or credential is proof-of-possession bound.
curl --request POST 'https://api.efilemagic.com/api/v1/w9/imports/start' \
--header 'Authorization: Bearer <access-token>' \
--header 'Idempotency-Key: <unique-operation-key>' \
--header 'Content-Type: application/json' \
--data-binary @request.jsonReplace placeholders with your own values. Use the API resource origin provided for your environment.
Create request.json using the documented fields. Field descriptions are not sample values.
Retrying a request? Keep the same idempotency key and body after an uncertain result. A different key can repeat the action.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
20 fieldscontent_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.
{
"data": {
"content_type": "string | null",
"created_at": "string (date-time)",
"created_by": "object",
"created_by_user_id": "string (uuid) | null",
"dispatch_requested": "boolean",
"dispatched_count": "integer",
"file_name": "string",
"issuer_id": "string (uuid) | null",
"notify_email": "string (email) | null",
"request_count_created": "integer",
"row_count_processed": "integer",
"row_count_total": "integer",
"rows_per_chunk": "integer",
"size_bytes": "integer | null",
"skipped_count": "integer",
"source_stage_completed": "boolean",
"status": "string",
"submission_id": "string (uuid)",
"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.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 409
conflict - Read the current state and resolve the conflict. Do not change the body under an existing idempotency key.
- 412
precondition_failed - Read the current version or preview again; a required precondition has changed.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id and retry an uncertain result with the same body and idempotency key.
- 503
service_unavailable - Retry with bounded backoff, preserving the body and idempotency key.
- 402
w9_capacity_required - Creating W-9 requests requires purchased capacity; sending them requires a paid request. Review W-9 capacity in E-File Magic before retrying.