Keep in mind
Data cannot be moved between environments — Sandbox data stays in Sandbox, and Live data stays in Live.

​
Sandbox

Just a heads-up!
All the data in the Sandbox environment is fake. It’s designed to help you get familiar with how Jobs work before executing them on real data sources.
Once you’ve created a free account, you’ll immediately receive your Client ID and Sandbox secret through the Dashboard. You can use the Sandbox to test all of your Jobs and ensure everything works as expected. When you’re ready to interact with real data, you can upgrade to get your Production secret from your Dashboard.

​
Using the Sandbox

To use the Sandbox environment, send your requests to: 
https://sandbox.deck.co/api/v1

​
Let’s give it a try!

Open the API Reference in a new tab. First, here is how to run EnsureConnection to get your Access token:
  • Click Try it while Send your job requests is selected from the menu on the left.
  • Use your Client ID and Sandbox secret (from the Dashboard) to authenticate.
  • Type EnsureConnection in the job_code field.
  • Click Add new property and type username, then press Enter.
  • Enter any value you want as the username (it doesn’t matter in Sandbox)
  • Click Add new property and type password, then press Enter.
  • Enter any value you want as the password (it doesn’t matter in Sandbox)
  • Click Add new property and type source_guid, then press Enter.
  • Enter fee328b0-fc48-4699-a245-5de34313952e as the source_guid (this is the source_guid for the source Aetna, but it could be any valid source_guid)
  • Click Send on top.
The response will come via webhook to the Webhook URL you have specified in your Dashboard. Alternatively, you can copy/paste the following curl request and inject the required fields. 
curl --request POST \
  --url https://sandbox.deck.co/api/v1/jobs/submit \
  --header 'Content-Type: application/json' \
  --header 'x-deck-client-id: <api-key>' \
  --header 'x-deck-secret: <api-key>' \
  --data '{
  "job_code": "EnsureConnection",
  "input": {
    "username": "<username>",
    "password": "<password>",
    "source_guid": "fee328b0-fc48-4699-a245-5de34313952e"
  }
}'
Now, let’s call FetchBalance to receive a balance. The balance you will receive is fake, because we’re in Sandbox, but it should give you an idea of the sort of webhooks FetchBalance would return.
Here is how to do it from the same API Reference page.
  • Click Try it while Send your job requests is selected from the menu on the left.
  • Use your Client ID and Sandbox secret (from the Dashboard) to authenticate.
  • Type FetchBalance in the job_code field.
  • Click Add new property and type access_token, then press Enter.
  • Enter the access token value you got from the earlier EnsureConnection webhook.
  • Click Send on top.
Check your webhooks. Here is the curl request. 
curl --request POST \
  --url https://sandbox.deck.co/api/v1/jobs/submit \
  --header 'Content-Type: application/json' \
  --header 'x-deck-client-id: <api-key>' \
  --header 'x-deck-secret: <api-key>' \
  --data '{
  "job_code": "FetchBalance",
  "input": {
    "access_token": "<access token>"
  }
}'
There you have it!
You now know how to make calls to our API. Of course, different Job Codes will require different inputs, but the core concept is the same across the board.

​
Live

Unlike the Sandbox, the Live environment connects to actual data sources. You can receive a Production secret by upgrading your subscription via the Dashboard. Use your Client ID and Production secret for authentication.
You will also need to point to the Live endpoint. You can change this by replacing “sandbox” for “live” in the URL. 
https://live.deck.co/api/v1
The method, however, is exactly like the Sandbox.
Know your environmentsThe Production environment uses the Live API and connects to real data.
The Sandbox environment uses the Sandbox API and works entirely with mock data.