Documents

Fetch exact raw bytes, parser structure, a typed document, or approved mapped output.

Credentials can read documents only in their exact Lab, Certification, or Production lane. document is available only where the registry proves typed receive; mapped is the approved customer mapping and canonical is its alias. Healthcare (PHI-classified) payloads are masked by default: every JSON view reports masked/revealed, and a raw download carries X-SignalEDI-Masked. Only an interactive dashboard session holding the reveal permission may pass reveal=true; API keys are refused with 403 PAYLOAD_REVEAL_FORBIDDEN before any tenant data is read, and a reveal that cannot be audited is refused with 503. Throttled at 120 calls per minute per API key.

get/v1/documents/{documentId}/payload

Request

  • Base URL: https://signaledi.com/api
  • URL: https://signaledi.com/api/v1/documents/{documentId}/payload
  • Auth: HTTP bearer

Path parameters

documentIdstring required

Query parameters

reveal'true' | '1'

true (or 1) asks for the unmasked payload. Honoured only for an interactive dashboard session whose role carries the reveal permission and only after a durable reveal audit record is written; any API key is refused with 403 PAYLOAD_REVEAL_FORBIDDEN before tenant data is read.

view'raw' | 'structured' | 'document' | 'mapped' | 'canonical'
downloadboolean

For view=raw, return the exact media bytes instead of Base64 JSON.

Response

Authorized document payload view. With download=true on the raw view the exact (or masked) bytes are returned with the headers below.

oktrue required
documentIdstring required
transactionIdstring
view'raw' | 'structured' | 'document' | 'mapped' required
environment'LAB' | 'CERTIFICATION' | 'PRODUCTION' required

The exact isolated lane identifier. The API route and payload remain the same. Lab is customer-to-Signal only; Certification uses the real third-party test route; Production is approved live exchange. SANDBOX is a historical request-only alias for Certification. Promotion creates an approved immutable version and never relabels traffic.

standard'x12' | 'edifact' | 'X12' | 'EDIFACT' required
direction'CUSTOMER_TO_PARTNER' | 'PARTNER_TO_CUSTOMER'
documentTypeCodestring
documentTypeCodesstring[] required
schemaVersionstring
transactionsobject[]
contentBase64string
contentEncoding'UTF-8' | 'ISO-8859-1'
byteLengthinteger
sha256string
maskedboolean

True when the payload contains healthcare-classified content that was masked before delivery. Non-sensitive payloads report false.

revealedboolean

True only after a gated, audited reveal=true succeeded for an interactive session; always false for API keys.

Changes

No recorded changes to this operation across all 1 revision of this API.