Ideavate Developer Hub
  • Guides
    • Getting Started
      • Access Token Issuance
      • Using GraphQL
      • Example GraphQL Queries
    • Open Utilities API
      • Introduction
      • Consent and credential sharing
      • Access levels
      • Data update notifications
      • Using Auth Link
    • Data APIs
      • QR code parser
      • Vehicle lookup
  • API Reference
    • Auth Link API
      • Security
      • GET /link
      • POST /token
      • GET /status
    • GraphQL API
      • Authentication
      • Data Model
      • GET or POST /graphql
      • Error Handling
      • Webhooks
  • GraphQL Explorer
Powered by GitBook
On this page
  • Terminology
  • High level process
  1. Guides
  2. Open Utilities API

Introduction

Introduction to Open Utilities API

PreviousOpen Utilities APINextConsent and credential sharing

Last updated 2 years ago

Terminology

A Provider is a business or organisation that supplies a utility or other kind of service to an End User. The End User is said to hold an Account with the Provider.

A Client Application is an application or service that wishes to get access to the Account details held by a Provider after gaining consent to do so from the End User.

The Open Utilities API are the set of APIs provided by Ideavate that allow a Client Application to achieve this consented access.

High level process

  1. End User gives consent and shares credentials

  2. Open Utilities API uses the credentials for accessing the Account data held by the Provider

  3. Client Application queries the data via Open Utilities API