E-File Magic

W-9 requests

Request W-9 reconfirmation

Create or update a reconfirmation workflow for an existing recipient.

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

Request fields

4 fields
expected_recipient_versionRequiredinteger

Recipient version from the latest read, used to detect a conflicting update. Minimum: 1.

filer_idRequiredstring (uuid)

ID of the filer that owns this operation's records.

recipient_idRequiredstring (uuid)

ID of the recipient within the selected filer.

send_immediatelyOptionalboolean

Whether to send the W-9 request as part of this operation. Default: false.

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: ApiV1W9ReconfirmationUpsertRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/w9/reconfirmations/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.