Describe the data you publish
Choose the records and fields to expose, and define their names and meaning for other services. Relay produces the interface and its documentation from that reviewed definition.
Registry Relay
Publish selected registry data.
Registry Relay gives other services a controlled interface to look up and read selected data from an existing registry. Define the fields, their meaning, and the rules for access, while keeping record maintenance in the source system.
One example: information for a public assistance service
Share enrollment details without the rest of the household record.
A public assistance service needs a household’s reference, district, and enrollment status to process an application. The registry team agrees to provide those fields while withholding the home address and payment details.
An illustrative sharing agreement
The registry owner controls which fields each service can receive.
Registry owner
Source record
Household record H-208
- Household reference
- H-208Shared
- District
- NorthfieldShared
- Enrollment status
- EnrolledShared
- Home address
- 14 Market LaneNot shared
- Payment details
- Account ending 4418Not shared
Corrections and updates stay in this source register.
Registry Relay
Field permissions
3 agreed fieldsReturned for this request
Other fields stay at source
Public assistance service
Selected data returned
Response · 3 fields
Household data H-208
- Household reference
- H-208
- District
- Northfield
- Enrollment status
- Enrolled
The service receives the agreed values and record reference.
Audit record Requested fields, access rules and purpose, outcome, and time.
A reusable interface for your registry
Define what services can read and how they find it.
Publish agreed information about people, households, businesses, facilities, or other records your organization maintains. Define permitted reads and lookups, with consistent field meanings and access rules for receiving services.
Give services specific access
Specify which reads and lookups are available and the records and fields each service may receive. A service can ask for fewer permitted fields, but its request cannot widen the access you have granted.
Keep context and a record of the read
Record identifiers and source context accompany the selected information so the receiving service can interpret it. Relay records the request and its outcome for audit.
How it fits your organization
Keep corrections in the source register.
Your organization owns and maintains the records. Registry Relay provides a read-only interface for other services, so a request for information leaves the source records unchanged.
Agree which information is useful, who may receive it, and how current the published data needs to be.
- Your registry team agrees the information
- Define the published records, field meanings, and access each service needs. Keep responsibility for corrections and updates with the source register.
- Your technical team prepares the data
- Provide the reviewed source view and any extraction or update process it requires. Configure Relay’s interface and access rules, and connect the receiving service.
- Choose the response your service needs
- When a service needs a defined fact, such as adult status or a residence region, Evidence Gateway can derive and sign that answer from a configured source.
For developers and implementers
Publish selected fields from a sample register.
The introductory tutorial uses a synthetic business register in SQLite. Publish its legal name and legal form, try a request for the withheld address, and inspect the audit record.
Run the SQLite publication tutorial →
Read the product documentation →- Source preparation
- Relay reads reviewed, read-only SQLite views. Spreadsheets and other databases require an organization-owned preparation step.
- Published interface
- The configuration defines resource names, fields, and access and disclosure rules. Relay generates the API contract and returns selected data with record context. These responses are unsigned.
- Building a register as well?
- Base Registry Engine stores and manages records for people, households, businesses, and other entities, with controlled changes and a history your team can inspect.
Work with us
Get help when you need it.
Get hands-on help through a paid implementation pilot, or ongoing support while your team builds and runs the solution.
Implementation and support