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/json" \
    -d '{"content":"ISA*...complete X12 interchange...~IEA*...~"}'

{
  "ok": true,
  "validation": { "sourceFormat": "X12", "transactionSet": "850", "valid": true, "issues": [] },
  "json": { "beginningSegment": { "poNumber": "4500" } }
}
120/min
parse + validate requests per API key
99.5–99.9%
monthly uptime commitment by plan (see /sla)
X12 · EDIFACT
envelope standards covered
997 · 999 · CONTRL
acknowledgements as webhooks

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

VercelAWS MarketplaceShopify+ 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 or EDIFACT inside the documented JSON request and receive a validated 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

Check envelope and structural compliance before a document ever reaches a trading partner. Catch framing failures in CI instead of in a chargeback; partner-specific profile rules are enforced at admission on /v1/documents/outbound.

  • X12 and EDIFACT envelope structure
  • Segment and control-number checks
  • Plain-English issue context
03POST /v1/documents/outbound

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/json" \
  -d '{"content":"ISA*...complete X12 interchange...~IEA*...~"}'
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/json",
    },
    body: JSON.stringify({ content: rawEdi }),
  },
);
const { validation, json } = 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']}",
    },
    json={"content": raw_edi},
)
doc = res.json()  # validation, structured json

// reference

The API at a glance

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

  • POST/v1/parse
    Raw X12/EDIFACT → validated structured JSON
  • POST/v1/validate
    Validate an X12 or EDIFACT interchange and get diagnostics
  • POST/v1/documents/outbound
    Submit typed JSON or exact raw EDI to an authorized partner lane
  • POST/v1/documents/inbound
    Admit partner-originated EDI through exact-match routing intelligence
  • GET/v1/document-types
    Discover raw, typed, mapped, and validation capabilities
  • GET/v1/documents/:documentId
    Fetch lifecycle, transport, delivery, and acknowledgement state

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/json" \
  -d '{"content":"ISA*...complete X12 interchange...~IEA*...~"}'

# → 200 OK
# {
#   "ok": true,
#   "validation": { "sourceFormat": "X12", "transactionSet": "850", "valid": true, "issues": [] },
#   "json": { /* structured parser output */ }
# }

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
  • Direct plug-in activation; downstream EDI uses Certification and Production

// 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 Marketplace, or Shopify? 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

Create an sk_lab_ key for customer-to-Signal development. Use an sk_cert_ key for partner testing; Production uses a separately authorized sk_live_ key and certified connection snapshot.

02

2 · Send a transaction

POST raw EDI to /v1/parse, submit a document through /v1/documents/outbound, or drop a file on SFTP.

03

3 · Exchange + reconcile

Poll the document receipt and handle signed metadata-only lifecycle and acknowledgement webhooks.

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. Vercel Connectable provisioning uses the same Stripe-direct path until Native marketplace billing is separately approved and enabled. The API and SFTP surface is identical either way.
Which EDI standards are supported?
The raw lane carries recognized X12 and EDIFACT message types when the customer account has an exact authorized partner profile, mapping, route, direction, and environment. Typed JSON is available only where /v1/document-types advertises typedSend or typedReceive; other types remain raw or approved-mapped payloads.
How do acknowledgements work?
Exchange is asynchronous. When a trading partner returns a 997, 999, TA1, or CONTRL, SignalEDI links it to the document receipt and emits a signed metadata-only acknowledgement event. Fetch the tenant-authorized payload through its pull link; SFTP integrations can also receive the approved file in their outbox.

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.