Draft

This is v2.2-draft — a working draft of the v2.2 standards, published for review and not yet ratified. It MUST NOT be used as the basis for a production implementation. For the current standards, switch to v2.1 using the version selector. See the v2.1 → v2.2-draft changelog for every change in this version.

API Specifications

API Hub v2.2-draft

The APIs the API Hub exposes to LFIs during the authorization journey — Headless Heimdall (for delegating end user authentication) and the Consent Manager (for looking up and updating consents).

Headless Heimdall Auth Server →

4 endpoints

GET/hello-mtlsHello MTLS→GET/authGet Auth→POST/auth/{interactionId}/doConfirmConfirm Authorization→POST/auth/{interactionId}/doFailFail Authorization→

Consent Manager →

13 endpoints

GET/hello-mtlsHello MTLS→GET/consentsGet Consents→GET/consents/{consentId}Get Consent by ID→PATCH/consents/{consentId}Get Consent by ID→GET/consents/{consentId}/auditGet Consent Audit→GET/consent-groups/{consentGroupId}/consentsGet Consents in Consent Group→GET/psu/{userId}/consentsGet Consents by End User→GET/accounts/{accountId}/consentsGet Consents by Account→POST/consent-groups/{consentGroupId}/consents/action/revokeRevoke Consents in Consent Group→POST/consents/{consentId}/action/revokeRevoke Consent→GET/payment-logGet Payment Log→PATCH/payment-log/{id}Get Payment Log→PATCH/insurance-quote-log/{logId}Patch Insurance Quote Log→