Built by the community
Navigation
Metrics
Program
Service DeskPricingPoliciesDocument RepositoryLive Ecosystem
Developer Docs
TPP — Open Finance StandardsLFI — Integration GuideAPI SpecsKnowledge BaseRelease Notes & Erratas
NewsGitHub
API Specifications

Ozone Connect v2.1

The APIs LFIs must implement for the API Hub to call — health check, consent events, bank data sharing, service initiation, Confirmation of Payee, products & leads, and ATMs.

Health Check →

3 endpoints
GET/helloHello→GET/hello-mtlsHello MTLS→GET/echo-certEcho Cert→

Consent Events →

2 endpoints
POST/consent/action/validateValidate consent before Creation→POST/consent/event/{operation}Event when a consent is updated or created→

Bank Data Sharing →

12 endpoints
GET/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/customerGet Customers→GET/accounts/{AccountId}/customerGet Customer for an Account→GET/accounts/{AccountId}/direct-debitsGet Direct Debits for an Account→GET/accounts/{AccountId}/productsGet 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 →

3 endpoints
POST/paymentsCreate a Payment→GET/payments/{PaymentId}Get a Payment by PaymentId→GET/payment-consents/{ConsentId}/refundRetrieve Account Details for a Refund→

Confirmation of Payee →

1 endpoint
POST/customers/action/cop-queryConfirm the IBAN matches the Name on the Account→

Products & Leads →

2 endpoints
GET/productsGet Products→POST/leadsSubmit Lead→

ATMs →

1 endpoint
GET/atmRetrieve ATMs→

CAAP →

17 endpoints
POST/users/actions/challenge/initializeInitialize a User Challenge→POST/users/actions/challenge/queryQuery a User Challenge→POST/users/actions/challenge/completeComplete a User Challenge→POST/users/actions/register/initializeInitialize User Registration→POST/users/actions/register/completeComplete User Registration→POST/users/actions/deregisterDeregister a User→POST/users/actions/pii/decryptDecrypt PII for a User→POST/consent/actions/validateValidate a Consent→GET/accountsRetrieve Accounts (CAAP)→GET/accounts/{accountId}Retrieve an Account (CAAP)→GET/employment-insurance-policiesRetrieve Employment Insurance Policies (CAAP)→GET/health-insurance-policiesRetrieve Health Insurance Policies (CAAP)→GET/home-insurance-policiesRetrieve Home Insurance Policies (CAAP)→GET/life-insurance-policiesRetrieve Life Insurance Policies (CAAP)→GET/motor-insurance-policiesRetrieve Motor Insurance Policies (CAAP)→GET/renters-insurance-policiesRetrieve Renters Insurance Policies (CAAP)→GET/travel-insurance-policiesRetrieve Travel Insurance Policies (CAAP)→

Insurance Data Sharing →

14 endpoints
GET/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 endpoints
POST/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→