Skip to main content

Connect a customer account to the EDI document API

Configure the complete customer, trading-partner, mapping, transport, Lab, Certification, and Production data flow for typed JSON or raw X12 and EDIFACT.

Quick answer

Does this support every X12 or EDIFACT message?

Lab accepts any structurally valid raw X12 or EDIFACT message and reports what the parser and mapping engine can prove. Certification and Production require an exact customer integration, partner profile, route, and approved mapping. Typed JSON is advertised only for types with executable schemas and renderers; use the public registry as the current source of truth.

More common questions →

The required account integration

Every document is authorized against one tenant-owned chain: customer account → Connect project → trading partner → direction → environment → active connection and gateway → document profile → approved mapping. The API rejects missing, cross-tenant, ambiguous, inactive, or wrong-lane authority.

Typed API and universal raw modes

In Lab, test the same endpoint with typed JSON payloads or raw X12 and EDIFACT. Use typed payload only for registry entries with typedSend=true. Use content for UTF-8 or contentBase64 plus contentEncoding for exact raw messages. Discover capabilities from GET /v1/document-types; a raw-only type never receives a guessed JSON schema.

curl -X POST https://api.signaledi.com/v1/documents/outbound \
  -H "Authorization: Bearer $SIGNALEDI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "partnerId": "your-partner-id",
  "environment": "LAB",
  "documentTypeCode": "850",
  "payload": {
    "purchaseOrderNumber": "PO-1042",
    "shipTo": {
      "id": "DC-01",
      "name": "RetailMart DC 01"
    },
    "lines": [
      {
        "lineNumber": 1,
        "sku": "SKU-100",
        "quantity": 24,
        "unitPrice": 12.5
      }
    ]
  }
}'

One contract, three identifiers

The route, body shape, SDK method, validation rules, and idempotency behavior stay the same. Set environment to LAB for customer-to-Signal development, CERTIFICATION for real third-party testing, or PRODUCTION for approved live exchange. Each lane has a separate key and stored authority; no record is relabeled during promotion.

Inbound connection intelligence

SignalEDI links an inbound file automatically only when envelope evidence identifies one exact active integration. If none exists or candidates are ambiguous, it preserves the evidence, holds the document, starts or reuses a Connect project, and places a Needs You request asking whether the customer wants to map it to a third-party partner.

  • Held documents are not forwarded
  • Confidence cannot replace profile and mapping authority
  • The discovery fingerprint reuses the same open Connect work instead of creating duplicates

Receipts, payloads, and promotion

Track admission, processing, routing, transport, acknowledgement, and customer delivery separately. Pull raw, structured, typed document, or approved mapped views according to capabilities. Promote only certified configuration to a new immutable Production version; Lab and Certification resources are never relabeled as Production.

Common questions

© 2026 SignalEDI Inc. All rights reserved.