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
Open Finance Standards v2.2-draft
The APIs the API Hub exposes to TPPs — Trust Framework discovery, registration, token exchange, consent, bank data sharing, service initiation, Confirmation of Payee, ATMs, and event notifications.
Token →
1 endpointConsent →
16 endpointsPOST
/parPushed Authorization Request endpoint→GET/account-access-consentsRetrieve Bank Data Sharing Consents by BaseConsentId→GET/account-access-consents/{ConsentId}Retrieve Bank Data Sharing Consent by ConsentId→PATCH/account-access-consents/{ConsentId}Modify a Bank Data Sharing Consent→GET/payment-consentsRetrieve Payment Consents by BaseConsentId→GET/payment-consents/{ConsentId}Retrieve Payment Consent by ConsentId→PATCH/payment-consents/{ConsentId}Modify a Payment Consent→GET/insurance-consentsRetrieve Insurance Data Sharing Consents by BaseConsentId→GET/insurance-consents/{ConsentId}Retrieve Insurance Data Sharing Consent by ConsentId→PATCH/insurance-consents/{ConsentId}Modify an Insurance Data Sharing Consent→POST/account-access-consents/{ConsentId}/attestationsAppend a Bank Data Sharing Attestation Event→GET/account-access-consents/{ConsentId}/attestationsList a Bank Data Sharing Attestation Events→POST/payment-consents/{ConsentId}/attestationsAppend a Bank Service Initiation Attestation Event→GET/payment-consents/{ConsentId}/attestationsList a Bank Service Initiation Attestation Events→POST/insurance-consents/{ConsentId}/attestationsAppend an Insurance Attestation Event→GET/insurance-consents/{ConsentId}/attestationsList an Insurance Attestation Events→Bank Data Sharing →
12 endpointsGET
/accountsGet Accounts→GET/accounts/{AccountId}Get an Account→GET/accounts/{AccountId}/balancesGet Balances for an Account→GET/accounts/{AccountId}/beneficiariesGet Beneficiaries for an Account→GET/accounts/{AccountId}/direct-debitsGet Direct Debits for an Account→GET/partiesGet Customers→GET/accounts/{AccountId}/partiesGet Customer for an Account→GET/accounts/{AccountId}/productGet Product Configuration for an Account→GET/accounts/{AccountId}/scheduled-paymentsGet Scheduled Payments for an Account→GET/accounts/{AccountId}/standing-ordersGet Standing Orders for an Account→GET/accounts/{AccountId}/statementsGet Statements for an Account→GET/accounts/{AccountId}/transactionsGet Transactions for an Account→Bank Service Initiation →
4 endpointsConfirmation of Payee →
2 endpointsProducts & Leads →
2 endpointsATMs →
1 endpointInsurance Data Sharing →
14 endpointsGET
/employment-insurance-policiesGet Employment Insurance Policies→GET/employment-insurance-policies/{InsurancePolicyId}Get a Employment Insurance Policy→GET/health-insurance-policiesGet Health Insurance Policies→GET/health-insurance-policies/{InsurancePolicyId}Get a Health Insurance Policy→GET/home-insurance-policiesGet Home Insurance Policies→GET/home-insurance-policies/{InsurancePolicyId}Get a Home Insurance Policy→GET/life-insurance-policiesGet Life Insurance Policies→GET/life-insurance-policies/{InsurancePolicyId}Get a Life Insurance Policy→GET/motor-insurance-policiesGet Motor Insurance Policies→GET/motor-insurance-policies/{InsurancePolicyId}Get a Motor Insurance Policy→GET/renters-insurance-policiesGet Renters Insurance Policies→GET/renters-insurance-policies/{InsurancePolicyId}Get a Renters Insurance Policy→GET/travel-insurance-policiesGet Travel Insurance Policies→GET/travel-insurance-policies/{InsurancePolicyId}Get a Travel Insurance Policy→Insurance Quotation →
28 endpointsPOST
/employment-insurance-quotesCreate a Employment Insurance Quote→GET/employment-insurance-quotes/{QuoteId}Retrieve a Employment Insurance Quote→PATCH/employment-insurance-quotes/{QuoteId}Accept a Employment Insurance Quote→POST/employment-insurance-policiesCreate a Employment Insurance Policy→POST/health-insurance-quotesCreate a Health Insurance Quote→GET/health-insurance-quotes/{QuoteId}Retrieve a Health Insurance Quote→PATCH/health-insurance-quotes/{QuoteId}Accept a Health Insurance Quote→POST/health-insurance-policiesCreate a Health Insurance Policy→POST/home-insurance-quotesCreate a Home Insurance Quote→GET/home-insurance-quotes/{QuoteId}Retrieve a Home Insurance Quote→PATCH/home-insurance-quotes/{QuoteId}Accept a Home Insurance Quote→POST/home-insurance-policiesCreate a Home Insurance Policy→POST/life-insurance-quotesCreate a Life Insurance Quote→GET/life-insurance-quotes/{QuoteId}Retrieve a Life Insurance Quote→PATCH/life-insurance-quotes/{QuoteId}Accept a Life Insurance Quote→POST/life-insurance-policiesCreate a Life Insurance Policy→POST/motor-insurance-quotesCreate a Motor Insurance Quote→GET/motor-insurance-quotes/{QuoteId}Retrieve a Motor Insurance Quote→PATCH/motor-insurance-quotes/{QuoteId}Accept a Motor Insurance Quote→POST/motor-insurance-policiesCreate a Motor Insurance Policy→POST/renters-insurance-quotesCreate a Renters Insurance Quote→GET/renters-insurance-quotes/{QuoteId}Retrieve a Renters Insurance Quote→PATCH/renters-insurance-quotes/{QuoteId}Accept a Renters Insurance Quote→POST/renters-insurance-policiesCreate a Renters Insurance Policy→POST/travel-insurance-quotesCreate a Travel Insurance Quote→GET/travel-insurance-quotes/{QuoteId}Retrieve a Travel Insurance Quote→PATCH/travel-insurance-quotes/{QuoteId}Accept a Travel Insurance Quote→POST/travel-insurance-policiesCreate a Travel Insurance Policy→