Get Document Status via API

This document will walk you through the process of getting a document status after posting a document through our API service.  If there are any associated acknowledgements associated with that document, it will also return that document in the response.

Endpoint

(GET) "/api/docs/edi-status?externalId={externalId}"

Required accesstoken.

externalId must not be empty.

Description

Retrieves the processing status of a document using its externalId.
If the document has an associated ACK file (AckPath), its content will also be returned as a byte array (byte[]).

Responses

✅ 200 OK

Returns the document's status and optional ACK file content.

json

{ "status": "Processed", // The current status of the document "ackContent": "BASE64_STRING" // Base64-encoded binary content of the ACK file (if available) }

If ackContent is not available, it will be an empty array ([] in C#, base64 empty string in JSON).

❌ 404 Not Found

Returned when no document matches the given externalId.

Example Requests

Curl:

curl -X GET "https://your-api.com/edi-status?externalId=INV123456 "
-H "Authorization: Bearer {your_token}"