Skip to main content
SignalEDI Platform · for developers & platform teamsAPI v1stable

Embed EDI in your product without becoming an EDI company

One Core API does parse → validate → exchange for X12 and EDIFACT. Call it over REST or drop files on SFTP. You ship your roadmap; we carry the trading-partner complexity.

REST + SFTPWebhooksX12 & EDIFACTUsage-meteredBYO billing or marketplace
~ parse-and-validate.sh
$ curl https://api.signaledi.com/v1/parse \
    -H "Authorization: Bearer $SIGNALEDI_API_KEY" \
    -H "Content-Type: application/edi-x12" \
    --data-binary @purchase-order.edi

{
  "transactionSet": "850",
  "valid": true,
  "document": { "beginningSegment": { "poNumber": "4500" } },
  "diagnostics": [],
  "usage": { "credits": 1, "latencyMs": 38 }
}
~40ms
median parse + validate latency
99.9%
API availability target
X12 · EDIFACT
envelope standards covered
997 · 999 · TA1
acknowledgements as webhooks

Buy direct, or provision through the marketplaces your customers already use

GitHubVercelAWS MarketplaceGoogle CloudAzureShopify+ your marketplace

// one engine

Parse, validate, exchange — exposed as middleware

The same engine that powers the SMB product, surfaced for your application. No business logic lives in your code.

01POST /v1/parse

Parse

Send raw X12/EDIFACT (or JSON/CSV) and receive a typed, structured representation. Envelope, group, and segment errors come back as machine-readable diagnostics, not a stack trace.

  • X12 + EDIFACT envelopes
  • Structured JSON output
  • Per-segment error codes
02POST /v1/validate

Validate

Run transactions against standard and partner-specific rule sets before they ever reach a trading partner. Catch compliance failures in CI instead of in a chargeback.

  • Standard + partner rule sets
  • Readiness scoring
  • Plain-English issue context
03POST /v1/exchange

Exchange

Hand off to trading partners over the transport they require — API, AS2, or SFTP — and get acknowledgements (997/999/TA1) back as webhook events you can reconcile.

  • API / AS2 / SFTP transport
  • 997 / 999 / TA1 webhooks
  • Idempotent delivery

// quickstart

One endpoint, your language

Same /v1/parse call from any stack. No SDK required — though we publish typed ones generated from the OpenAPI spec.

cURLAny shell, zero dependencies
curl · /v1/parse
curl https://api.signaledi.com/v1/parse \
  -H "Authorization: Bearer $SIGNALEDI_API_KEY" \
  -H "Content-Type: application/edi-x12" \
  --data-binary @purchase-order.edi
Node.jsfetch — no SDK required
node · /v1/parse
const res = await fetch(
  "https://api.signaledi.com/v1/parse",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.SIGNALEDI_API_KEY}`,
      "Content-Type": "application/edi-x12",
    },
    body: rawEdi,
  },
);
const { transactionSet, valid, diagnostics } = await res.json();
Pythonrequests — drop-in
python · /v1/parse
import os, requests

res = requests.post(
    "https://api.signaledi.com/v1/parse",
    headers={
        "Authorization": f"Bearer {os.environ['SIGNALEDI_API_KEY']}",
        "Content-Type": "application/edi-x12",
    },
    data=raw_edi,
)
doc = res.json()  # transactionSet, valid, diagnostics

// reference

The API at a glance

A small, predictable surface. Versioned, scoped by API key, metered per call.

  • POST/v1/parse
    Raw X12/EDIFACT → typed, structured JSON
  • POST/v1/validate
    Run standard + partner rule sets, get diagnostics
  • POST/v1/exchange
    Hand off to a trading partner over API/AS2/SFTP
  • GET/v1/transactions/:id
    Fetch lifecycle + acknowledgement state
  • POST/v1/webhooks
    Subscribe to 997/999/TA1 + lifecycle events
  • GET/v1/usage
    Metered credit usage for billing reconciliation

Full reference, schemas, and error codes in the API docs.

// two front doors

Call an API or drop a file — same engine

Pick the integration model that fits your stack. Many teams use both.

For teams that want code-level control

REST API

A versioned, predictable REST surface. Authenticate with a scoped API key, POST a payload, and handle a structured response. Webhooks push lifecycle and acknowledgement events back to you.

  • Bearer API keys with per-key scopes and rotation
  • Synchronous parse/validate; async exchange with webhooks
  • OpenAPI spec + typed SDKs you can generate from it
  • Idempotency keys and usage metering on every call
bash · Parse + validate an X12 850 over REST
curl https://api.signaledi.com/v1/parse \
  -H "Authorization: Bearer $SIGNALEDI_API_KEY" \
  -H "Content-Type: application/edi-x12" \
  --data-binary @purchase-order.edi

# → 200 OK
# {
#   "transactionSet": "850",
#   "valid": true,
#   "document": { /* structured JSON */ },
#   "diagnostics": []
# }

For systems that already speak files

SFTP file transfer

Some platforms and ERPs only emit files. Drop X12/EDIFACT into a per-tenant SFTP inbox and we parse, validate, and exchange on a schedule — then write results and acknowledgements back to an outbox. No code change on your side.

  • Per-tenant inbox / outbox with key-based auth
  • Same parse → validate → exchange engine as the API
  • Results + acknowledgements written back as files
  • Webhook or email notification on each batch
text · Drop a file; collect results from the outbox
sftp tenant_acme@sftp.signaledi.com
sftp> put purchase-order.edi  /inbox/

# minutes later, in /outbox/:
#   purchase-order.result.json     # structured + validation
#   purchase-order.997.edi         # functional ack

// for marketplaces & platforms

List SignalEDI as a one-click integration

Run a marketplace, app store, or platform your customers build on? Offer EDI as an installable integration without building a compliance engine. We expose provisioning, scoped tokens, usage metering, and billing hooks so your users add EDI the same way they add any other integration — install, authorize, done.

  • OAuth-style install + token-resolved provisioning
  • Usage metered back to the marketplace for revenue share
  • Co-branded or white-label developer surface
  • Sandbox + production environments per tenant

// your billing, your way

Come to us directly, or buy through a marketplace

The integration surface is identical. Only the billing and identity relationship changes.

Come directly to us

Sign up, generate an API key, and start on a metered developer plan. You hold the billing relationship with SignalEDI and manage keys, usage, and invoices yourself.

  • Self-serve API keys in minutes
  • Usage-based metering, transparent pricing
  • Upgrade to committed volume when you scale

Provision through a marketplace

Already buying through Vercel, AWS, GCP, Azure, Shopify, or an automation marketplace? Provision SignalEDI from there and let that marketplace handle billing and identity. We resolve the marketplace token to a scoped account and meter usage back to it.

  • Marketplace handles billing + identity
  • Token-resolved provisioning to a scoped account
  • Same API + SFTP surface, no second integration

// how it works

From zero to reconciled in four steps

01

1 · Get a key

Sign up direct or provision via a marketplace. Either way you land with a scoped API key and an SFTP inbox.

02

2 · Send a transaction

POST a payload to /v1/parse or drop a file on SFTP. Get structured output and validation diagnostics back.

03

3 · Exchange + reconcile

Trigger exchange to a trading partner and subscribe to webhooks for 997/999/TA1 acknowledgements.

04

4 · Scale on metered usage

Watch usage in the dashboard; billing flows through us or your marketplace. No per-document traps.

Developer FAQ

How is this different from the SMB SignalEDI product?
Same core engine, different surface. SMB teams use the full SignalEDI app to run their own EDI operations. The platform exposes that same parse/validate/exchange engine as an API + SFTP middleware you embed in your own product. Picking one never limits the other.
Do I have to choose API or SFTP?
No. They are two front doors to the same engine. Many teams parse/validate over the API in their app and accept file drops over SFTP from partners who only speak files. Usage is metered the same way on both.
Who bills me?
Your choice. Come to us directly and SignalEDI bills you on a metered developer plan, or provision through a supported marketplace and that marketplace bills you. The API and SFTP surface is identical either way.
Which EDI standards are supported?
X12 and EDIFACT envelopes today, with the same transaction-set coverage as the core platform (e.g. 850/855/856/810 in retail, 837/835/270/271 in healthcare). You receive structured JSON regardless of the inbound format.
How do acknowledgements work?
Exchange is asynchronous. When a trading partner returns a 997, 999, or TA1, we deliver it as a webhook event (API) or a file in your SFTP outbox so you can reconcile delivery state in your own system.

Ship EDI without the EDI project

Get a scoped API key and an SFTP inbox in minutes. Bill through us or your marketplace.

© 2026 SignalEDI Inc. All rights reserved.