Home/Integration & Developer/Registration and declaration

Trusted Records · Integration & Developer

Registration and declaration

Request declaration for validated/QC packages under file plans and approval authority.

Service Playground — task-based experience OpenAPI and Swagger Reference

Request schema from OpenAPI

Field	Type	Required	Constraints	Technical definition
`packageId`	string	Yes	`{"minLength": 1, "maxLength": 128}`	Intake package identifier linked to validation jobs.
`recordClass`	string	Yes	`{"minLength": 1}`	Classification code under the agreed records scheme.
`qcRef`	string	Yes	`{"minLength": 1, "maxLength": 128}`	QC decision reference; registration must follow successful validation and authorized review.

Read the operation and next actions

Swagger · declare

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/records/declarations · scope records:declare. Tenant/project and correlation contexts are required. POST/PATCH use Idempotency-Key; examples/schemas below are proposed contracts.

States and outputs

REQUESTED → REVIEW_PENDING → APPROVED / REJECTED → DECLARED. Jobs cannot bypass approval.

Exceptions and controls

Missing QC or invalid classifications return 422; insufficient permission returns 403.

HTTP example — proposed contract

Request

POST https://records.example.invalid/v1/records/declarations 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

{
  "packageId": "synthetic-package-001",
  "recordClass": "synthetic-class-001",
  "qcRef": "synthetic-qc-001"
}

Response · 202

{
  "jobId": "synthetic-job-002",
  "status": "REVIEW_PENDING",
  "declarationRef": "synthetic-declaration-001"
}

Required fields and shared controls

Item	Proposed rule
scope	records:declare
required	packageId, recordClass, qcRef
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