Home/Integration & Developer/Preservation packages

Trusted Records · Integration & Developer

Preservation packages

Request SIP validation and AIP creation/management under approved profiles.

Service Playground — task-based experience OpenAPI and Swagger Reference

Request schema from OpenAPI

Field	Type	Required	Constraints	Technical definition
`recordIds`	array	Yes	`{"minItems": 1}`	Registered records eligible for the preservation request.
`profileRef`	string	Yes	`{"enum": ["synthetic-preservation-001", "synthetic-signed-evidence-001", "synthetic-born-digital-001"], "minLength": 1, "maxLength": 128}`	Preservation profile identifier; synthetic examples are unapproved reference profiles.

Read the operation and next actions

Swagger · preserve

Errors and next actions

A consistent error envelope guides recovery without disclosing sensitive data.

Read details

Reliability, concurrency and recovery

Retry design follows the side effect rather than repeating every request blindly.

Read details

API Explorer — local simulator

Explore requests/responses and failure scenarios using synthetic data; no backend connection.

Read details

Input, scopes and processing

POST /v1/preservation-packages · scope preservation:write. Tenant/project and correlation contexts are required. POST/PATCH use Idempotency-Key; examples/schemas below are proposed contracts.

States and outputs

SIP_VALIDATING → AIP_PENDING → PRESERVED / EXCEPTION. Fixity/format checks continue over time.

Exceptions and controls

Missing representations/profiles return 422; policy/version conflicts return 409; fixity mismatches create exceptions.

HTTP example — proposed contract

Request

POST https://records.example.invalid/v1/preservation-packages HTTP/1.1
Authorization: Bearer <example-token>
X-Tenant-Id: synthetic-tenant-001
X-Project-Id: synthetic-project-001
X-Correlation-Id: synthetic-correlation-001
Idempotency-Key: synthetic-key-001
Content-Type: application/json

{
  "recordIds": [
    "synthetic-record-001"
  ],
  "profileRef": "synthetic-preservation-001"
}

Response · 202

{
  "jobId": "synthetic-job-004",
  "status": "SIP_VALIDATING",
  "packageRef": "synthetic-aip-001"
}

Required fields and shared controls

Item	Proposed rule
scope	preservation:write
required	recordIds, profileRef
tenant / project	Token and context must match; headers alone are insufficient.
idempotency	POST/PATCH: same key/body returns original result; changed body returns 409; confirm retention window.
error	code, message, requestId, correlationId, retryable, details; no sensitive data.

Continue the workflow

Two journeys, one records lifecycle

Connect paper and born-digital records through persistent identifiers, policies and evidence.

Read details

Integration quickstart

Exercise ingest → job tracking → registration → verification with synthetic data.

Read details

Integrity, provenance and evidence

Each evidence type answers a different question; hashes, timestamps and approvals are not interchangeable.

Read details

Start with a verifiable scope.

Agree record classes, quality criteria, permissions and evidence before scaling.

Plan assessment