E-File Magic

W-9 requests

Create or update a W-9 request

Save a request to collect a W-9 from a recipient.

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

Request fields

13 fields
emailRequiredstring (email)

Minimum characters: 3. Maximum characters: 254.

account_refOptionalstring | null

Maximum characters: 80.

business_nameOptionalstring | null

Maximum characters: 160.

entity_type_cdOptionalstring | null

Allowed values: "B", "I".

expected_versionOptionalinteger | null

Version from the latest read of the record. A changed version requires review before updating. Minimum: 1.

issuer_idOptionalstring (uuid) | null

ID of the sender issuing the W-9 request.

person_first_nmOptionalstring | null

Maximum characters: 160.

person_last_nmOptionalstring | null

Maximum characters: 160.

person_middle_nmOptionalstring | null

Maximum characters: 160.

person_suffix_nmOptionalstring | null

Maximum characters: 160.

recipient_nameOptionalstring | null

Maximum characters: 160.

request_idOptionalstring (uuid) | null

ID of the W-9 request.

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.

Complete request schema: ApiV1W9RequestUpsertRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/w9/requests/upsert' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Idempotency-Key: <unique-operation-key>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace 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.