E-File Magic

Filers

Create or update a filer

Save a filer and validate its business details.

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

Request fields

56 fields
filer_programRequiredstring

Allowed values: "app_1099_class", "app_1042s".

nameRequiredstring

Minimum characters: 1. Maximum characters: 256.

address1Optionalstring | null

Maximum characters: 2000.

address2Optionalstring | null

Maximum characters: 2000.

address_line1Optionalstring | null

Maximum characters: 2000.

address_line2Optionalstring | null

Maximum characters: 2000.

chapter3_status_codeOptionalstring | null

Maximum characters: 2000.

chapter4_status_codeOptionalstring | null

Maximum characters: 2000.

cityOptionalstring | null

Maximum characters: 2000.

codeOptionalstring | null

Maximum characters: 2000.

contact_nameOptionalstring | null

Maximum characters: 2000.

countryOptionalstring | null

Maximum characters: 2000.

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

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