LogoLogo
Developer GuideAPI GuideChangelogDeprecation ScheduleStatus
Documentation
Documentation
  • Overview
  • Systems in the grid
  • Key Concepts
    • Terminology
    • Fair-usage Policy
  • Get Started
    • Overview
    • API Keys
    • Onboard Your Customer
    • Access Your Customer Data
  • Consent
    • Overview
    • Create Consent
    • Grant Consent
    • Consent Status
  • Onboarding Flow
    • Overview
    • Onboarding Flow
      • One-Time Code
      • Accounting Systems
  • Client Portal
    • Overview
    • My Consents
    • Branding
    • API Keys
    • Environments
      • Development
      • Production
  • File.1
    • Overview
    • How does File.1 work?
  • Proxy.1
    • Overview
  • Security
    • Company Security
    • Platform Security
    • API Security
    • Data Residency and Compliance
      • Data Retention Periods
    • Compliance
  • Demos
    • Demos
Powered by GitBook
On this page
  • RESTful APIs
  • JSON Responses
  • API Key
  • Correlation ID
  • Polling

Was this helpful?

  1. Get Started

Overview

RESTful APIs

Our APIs have been developed following a RESTful architecture.

JSON Responses

All our response are in JSON format.

API Key

In order to access API.1, you must first create an API Key. You can create an API Key in the Client Portal.

You must pass the following HTTP header when you make API calls.

x-api-key: apikey

Correlation ID

For traceability when helping us to support you in your development and ongoing use of API.1, you must generate and pass a unique Correlation GUID on each API request.

Polling

You access data from Your Customer's Accounting System by polling API.1 to access the data.

PreviousFair-usage PolicyNextAPI Keys

Last updated 10 months ago

Was this helpful?