Ingest an immutable document

Existing synchronous 201 contract. Multipart file plus optional xml and validationReport components; all bytes streamed. Retry identical input with the same tenant-scoped key.

POST/api/archive

Ingest an immutable document

curl --request POST \
  --url 'https://app.output.rocks/api/archive' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --data '{
  "file": "string",
  "xml": "string",
  "validationReport": "string",
  "metadata": "string",
  "externalId": "string",
  "legalClass": "<string>",
  "dispositionDate": "2024-08-23T00:00:00+00:00",
  "idempotencyKey": "string"
}'

400

application/json

{
  "status": 1,
  "message": "string",
  "errorCode": "request.invalid",
  "violations": [
    {
      "errorCode": "validation.not_unique"
    }
  ]
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Header Parameters

Idempotency-Key

string

Required here or as idempotencyKey in the body. Both, if given, must agree. Changed inputs conflict.

Request Body

multipart/form-data

required

{
  "file": "string",
  "xml": "string",
  "validationReport": "string",
  "metadata": "string",
  "externalId": "string",
  "legalClass": "<string>",
  "dispositionDate": "2024-08-23T00:00:00+00:00",
  "idempotencyKey": "string"
}

Response

400application/json

Invalid input

status

integer

HTTP status code.

message

string

Human-readable message; do not use for programmatic decisions.

errorCode

string

Stable, readable error code. Unknown codes must be handled generically.

violations

object[]

errorCode

value

Example: "request.invalid"