Introduction

Deck provides you with a set of endpoints that simplify access to user-permission data. You can query and receive data in a consistent manner, making it possible to simplify sustainability work, better manage bill payments, improve credit risk assessment, and many more use-cases.

Getting Started

Sign up

Create an account here You'll access the Dashboard, your central hub for managing everything related to the Deck API.

Set up

Use the Dashboard to:

  • Set up your team - invite team members & manage accesses
  • Manage API Keys
  • Customize your user permission experience: management of user consdent and the Deck Link

Environments

Once logged in, you’ll find keys to access three environments:

  • Sandbox Environment: Ideal to get started, it uses fake data for initial testing.
  • Development Environment: Access real data for a limited number of accounts to test with trusted developers.
  • Production Environment: Provides unlimited access to real data, with usage billing.

📘

The Development and Production environment use the Live API and let you access real world data, while the Sandbox environment uses the Sandbox API and access mock data.