The Registry API is the service API of the Impact Hub Registry. Use it for registry-facing workflows such as project, household, device, credit and claim reporting.
It is an application service, not a direct IXO Protocol gateway. Protocol-level claim semantics and module transactions belong on the IXO Protocol API pages.
Authentication
Registry deployments can use service-specific credentials. The historical examples for this API include HTTP Basic auth.
Authorization: Basic <base64(username:password)>Do not assume one auth scheme across all registry environments. Confirm active requirements in
the Authentication matrix (/reference/authentication-matrix).
Endpoint groups
- System health and API docs
- Household and device reporting
- Fuel and claims reporting
- Credit lifecycle reporting
Base URL
Environment literals for this API have appeared in earlier versions of the docs. This page does not treat them as canonical. Get the base URL for your deployment from your operator, and check Networks and endpoints and the Authentication matrix before you integrate.
Troubleshooting
| Problem | Cause and fix |
|---|---|
401 Unauthorized with Basic auth | Wrong username or password, or the environment rotated its credentials. Re-read the deployment row in the Authentication matrix. |
403 Forbidden | Authenticated but missing the role or scope for that registry route. Check the operator's RBAC and which programme the credentials belong to. |
404 on resource paths | Registry API versions and path prefixes differ by deployment. Confirm the OpenAPI document and base URL with your operator (Networks and endpoints). |
| Payload validation errors | Compare field names with the operator's schema. Many issues are missing required reporting fields, not transport failures (Errors). |