Identify the system of record and the actual handoff.
Describe the event that should trigger work: an approved draft, an accepted service request or a change in a record. Name the sending system, receiving system and accountable owners. State what each system should do and which record remains authoritative.
A payment link is not a payment integration, and a page embedded in another site does not establish data synchronization. If a clearly labeled service link solves the need, it may avoid unnecessary moving parts. Describe the user task before committing to a connection.
Check the connection you can actually use.
Ask the platform owner for current documentation, available operations, account permissions, licensing conditions, rate limits, test environment and support contact. “Has an API” does not establish that the required fields or write operations are available to your agency.
Confirm how access is granted, reviewed, revoked and recovered through approved administration. Keep secrets and live resident records out of the planning document. The agency’s technical and security reviewers should approve the access and data handling appropriate to the connection.
The GOV.UK API documentation guide (opens in a new tab) explains the value of task-based guidance, examples, version information and support context. Those are useful questions to bring to a provider; they are not evidence that a specific platform supports the proposed connection.
Agree on field meaning, not just field names.
| Mapping question | Why it matters | Record before implementation |
|---|---|---|
| Which ID identifies the same item? | Names and display numbers can change or be reused. | A stable cross-system identifier and duplicate rule. |
| Who owns each field? | Two systems can overwrite each other with different values. | Authoritative source and permitted update direction. |
| What does each status mean? | A sent transfer is not necessarily an accepted transfer. | State mapping and handling of unknown states. |
| Which time is recorded? | Local times and delayed messages can be misleading. | Event time, receipt time and named timezone treatment. |
| Which fields may be public? | Internal notes may not belong in resident updates. | Explicit visibility and data-handling rules. |
On a small screen, scroll the table sideways to see every column.
Retain unknown values as unknown. Do not silently turn a missing owner into an accepted assignment or a failed lookup into a completed case.

Plan missing, repeated and out-of-order messages.
List how staff will detect a connection failure, what work is safe to retry and who reconciles unresolved records. A timeout can leave the sender uncertain whether the receiver acted. A retry needs an agreed duplicate-prevention or reconciliation approach; it should not blindly create another request.
Distinguish temporary unavailability from validation or permission failures. Avoid retrying invalid data forever. Keep a visible unresolved queue or equivalent review process with a named owner, and record enough context for diagnosis without exposing unnecessary sensitive data.
The government API technical guidance (opens in a new tab) provides reference context for interfaces and error behavior. Exact retry, versioning and security decisions must follow the connected systems’ current contracts and the agency’s approved implementation.
Test the record in both systems.
Use controlled test data and confirm the expected result at each end. Include a normal update, missing required field, duplicate event, lost response, delayed update, revoked permission and unavailable receiving system. Check that an unsuccessful operation remains visible for follow-up.
Document the expected output, observed record, owner of any discrepancy and release decision. A dashboard that says “sent” is evidence of a sending step; it does not by itself prove that the receiving team accepted or completed the work.
Leave a supportable connection behind.
Handover should identify the data mapping, permitted access, operational owners, change-notification process, monitoring, incident steps and reconciliation procedure. Plan a review when a vendor changes its interface or the agency changes a workflow.
If the integration exists to support request tracking, link its events to the service measurement definitions. If the supported operations are still uncertain, revisit the configure, buy or build decision before promising implementation.
Use the workflow workbook to map responsibility, then review workflow implementation support for the agreed scope.
Specify a usable history export, not just a download button.
Define the receiving use before choosing an export. A current snapshot supports a queue review, while an event history supports handoff and reopening analysis. If both are needed, preserve stable identifiers and relationships. Personal data exports, public release and operational migration are different authorized purposes.
| Source element | Export form to specify | Validation |
|---|---|---|
| Request identity | Stable text Request ID | Unique, retained across related records; preserve leading zeros. |
| Current snapshot | Category, status, owner, next action and update time | One current record per request; values match documented meanings. |
| Event history | Event ID, Request ID, event type, timestamp and actor role/reference | Every event has a valid parent and an interpretable timezone. |
| Outcome | Separate closure result, verification reference and closure time | Administrative closure is not automatically Completed. |
| Attachments | Authorized files plus an ID/path manifest | Manifest links to the right case and files remain retrievable. |
| Definitions | Schema version, field descriptions, status dictionary and extraction time | Receiving team can interpret nulls, changes and date formats. |
On a small screen, scroll the table sideways to see every column.
Reconcile record counts, duplicate IDs, orphan events, missing files and timestamps before accepting an export. Sample ordinary, reopened, duplicate and referred cases and inspect their full histories. Keep a record of omitted fields and rejected rows. An export is not usable if its file links expire before the receiving team can retrieve them.
Apply approved access, retention and transfer controls. The metrics export checks explain why current status alone cannot reconstruct historical performance. Export availability does not authorize public release of the underlying records.


