Verdn uses API keys to authenticate requests. All requests without a valid key will be rejected by the API.

You can create and manage these API keys in the Verdn dashboard. In order to authenticate a request to the Verdn API, pass your key as an HTTP Authorization request header prefixed with the Bearer keyword.

​
Key Modes

When creating an API key, you are given the option to create a test key or a live key. Testing keys start with verdn_sk_test while production keys start with verdn_sk_live. You can use any API endpoint with either your test or your live key.

All API JSON response bodies contain an isLive property which indicates the live status (i.e., testing or production) of that request.

​
Key Levels

There are also two levels of API keys: unit-level keys and team-level keys.

  • A unit-level key performs a request authenticated as that unit itself. These keys can be created and managed via the unit’s settings dashboard.
  • A team-level key performs a request on behalf of a unit. These keys can be created and managed via the team’s settings dashboard. Moreover, team-level requests require an additional X-Verdn-Unit-Id header for unit authentication. This unit ID can be found within that unit’s settings dashboard.