Transactions

Fetch a masked raw, structured, mapped, or registry-typed transaction payload.

Payloads are masked by default and every response reports masked/revealed. Unmasked healthcare payloads require an interactive privileged session (reveal=true), an active tenant BAA, and durable reveal audit evidence; API keys are refused with 403 PAYLOAD_REVEAL_FORBIDDEN before any tenant data is read.

get/v1/transactions/{id}/payload

Request

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

Path parameters

idstring required

Query parameters

view'raw' | 'structured' | 'canonical' | 'mapped' | 'document'
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.

Response

Transaction payload (masked unless an audited reveal succeeded).

oktrue required
transactionIdstring required
view'raw' | 'structured' | 'canonical' | 'document' required

mapped is reported as canonical.

documentTypestring required
documentTypeCodestring

document view only.

schemaVersionstring

document view only.

directionstring

document view only.

environmentstring

document view only.

standard'x12'

document view only.

payloadunknown required
maskedboolean required

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

revealedboolean required

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.