curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.edi.stateset.com/v1/documents/{id}' \
--header "Authorization: Bearer $EDI_API_TOKEN"
{
"acknowledgment": "string",
"document": {
"control_number": "string",
"correlation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"direction": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"processed_at": "2026-08-31T14:22:05Z",
"reference": "ORD-10042",
"status": "pending",
"transaction_set": "string"
},
"parsed": null,
"raw": "string",
"segments": [
{}
],
"validation_error": "string",
"validation_issues": [
{
"code": "string",
"component": 1,
"element": 1,
"message": "Two-person tent, green — replacement for damaged pole set.",
"recorded_severity": "error",
"segment": "string",
"segment_position": 1,
"value": "49.00",
"severity": "string",
"snip_level": 1,
"suggested_fix": "string"
}
]
}
Document detail
Document drill-down detail
GET
/
v1
/
documents
/
{id}
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.edi.stateset.com/v1/documents/{id}' \
--header "Authorization: Bearer $EDI_API_TOKEN"
{
"acknowledgment": "string",
"document": {
"control_number": "string",
"correlation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"direction": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"processed_at": "2026-08-31T14:22:05Z",
"reference": "ORD-10042",
"status": "pending",
"transaction_set": "string"
},
"parsed": null,
"raw": "string",
"segments": [
{}
],
"validation_error": "string",
"validation_issues": [
{
"code": "string",
"component": 1,
"element": 1,
"message": "Two-person tent, green — replacement for damaged pole set.",
"recorded_severity": "error",
"segment": "string",
"segment_position": 1,
"value": "49.00",
"severity": "string",
"snip_level": 1,
"suggested_fix": "string"
}
]
}
Path parameters
string
required
Document audit ID
Response
DocumentDetail
string,null
Generated 997 / TA1 / CONTRL acknowledgment for inbound documents.
DocumentRecord
required
An entry in the processed-document log.
Show DocumentRecord
Show DocumentRecord
string
required
string
Ties this record to the request’s logs (and, for outbound, its delivery). Defaulted for log lines written before correlation tracking existed.
string
required
inbound or outbound.string
required
string
required
string (date-time)
required
string
required
Human-readable handle: PO number, shipment ID, invoice number.
string
required
accepted, rejected, generated, queued, or legacy sent.string
required
Transaction set ID, e.g.
850.object
Canonical parsed payload returned by the transaction parser.
string
required
Full raw interchange or outbound wire that produced this record.
object[]
X12 segment list when available. Empty for EDIFACT until message-level segment rendering is promoted into the EDIFACT crate API.
string,null
Partner-guide or parser failure when the document was rejected.
RejectionDetail[]
Structured guide findings with 999-grade segment/element positions. Accepted inbound findings without a validation error remain advisory warnings, including after persistence or partner-policy changes. SNIP levels and remediation details match the processing response.
Show RejectionDetail
Show RejectionDetail
string
required
Stable machine code:
set_not_accepted, missing_segment, missing_reference, missing_element, value_not_allowed, too_short, too_long, too_few, too_many, missing_qualified_segment, count_mismatch, bad_format, or condition_failed.integer,null
1-based component selected by an element rule. EDIFACT defaults to 1; omitted for whole X12 elements and legacy findings without this detail. Minimum:
1.integer,null
1-based element position (999 IK4-01 numbering). Minimum:
0.string
required
RecordedSeverity,null
Severity recorded by the producer of a document-ledger finding. Allowed values:
'error', 'warning'.string
Segment tag the issue is about (empty for set-level issues).
integer,null
1-based position counting ST (X12, 999 IK3-02) or UNH (EDIFACT) as 1. Absent when the segment is missing entirely. Minimum:
0.string,null
The offending value, when one is present.
string
required
Effective processing severity:
error or warning. Accepted advisory findings use warning, preserving their SNIP classification and detail.integer (int32)
required
SNIP integrity level: 2 envelope, 3 implementation-guide, 4 value/code-set. Minimum:
0.string,null
A short remediation hint, when one is known for this issue’s code.
Status codes
| Code | Meaning |
|---|---|
200 | Document drill-down detail |
403 | Admin credential required |
404 | Unknown document |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.edi.stateset.com/v1/documents/{id}' \
--header "Authorization: Bearer $EDI_API_TOKEN"
{
"acknowledgment": "string",
"document": {
"control_number": "string",
"correlation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"direction": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"processed_at": "2026-08-31T14:22:05Z",
"reference": "ORD-10042",
"status": "pending",
"transaction_set": "string"
},
"parsed": null,
"raw": "string",
"segments": [
{}
],
"validation_error": "string",
"validation_issues": [
{
"code": "string",
"component": 1,
"element": 1,
"message": "Two-person tent, green — replacement for damaged pole set.",
"recorded_severity": "error",
"segment": "string",
"segment_position": 1,
"value": "49.00",
"severity": "string",
"snip_level": 1,
"suggested_fix": "string"
}
]
}
Last modified on October 20, 2026