W-9 requests
Inspect a W-9 import
Read the uploaded columns and validation results for a W-9 import.
/api/v1/w9/imports/inspect- Authentication
- OAuth 2.0 access token
- Required scopes
w9.read- Idempotency key
- Not required
- Rate-limit cost
- 2 units
How to use this endpoint
Use the submission ID from create_upload. Resolve the reported mapping or input issues before starting the import.
curl --request POST 'https://api.efilemagic.com/api/v1/w9/imports/inspect' \
--header 'Authorization: Bearer <access-token>' \
--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.
preview_rowsOptionalinteger | null
Number of source rows to include in the inspection preview. Minimum: 1. Maximum: 100.
Headers (2)
AuthorizationRequired- OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
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/inspect' \
--header 'Authorization: Bearer <access-token>' \
--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.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
6 fieldscontent_typeAlways returnedstring
Type: string.
file_nameAlways returnedstring
Type: string.
has_moreAlways returnedboolean
Type: boolean.
submission_idAlways returnedstring (uuid)
Type: string (uuid).
total_rowsAlways returnedinteger
Minimum: 0.
total_rows_exactAlways returnedboolean
Type: boolean.
{
"data": {
"content_type": "string",
"file_name": "string",
"has_more": "boolean",
"submission_id": "string (uuid)",
"total_rows": "integer",
"total_rows_exact": "boolean"
},
"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.
- 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; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.