Authentication

Every request to the Connect API carries an API key as a bearer token. Keys are created in the portal and scoped to your account's own connected accounts.

The bearer scheme

Send your key in the Authorization header on every request:

http

Authorization: Bearer edk_a1B2c3D4_EXAMPLEexampleEXAMPLEexampleEXAMPLEexample1

A complete request looks like this:

bash

curl https://api.endute.com/v1/accounts \
  -H "Authorization: Bearer edk_a1B2c3D4_EXAMPLEexampleEXAMPLEexampleEXAMPLEexample1"

There is no OAuth flow and no session. The key is the single credential, so treat it as a secret.

Key format

Every key begins with the edk_ prefix (Endute Connect key) and matches this fixed pattern:

regex

edk_[A-Za-z0-9_-]{8}_[A-Za-z0-9_-]{43}

That is the literal edk_, an eight-character segment, an underscore, then a forty-three-character segment, all from the URL-safe alphabet A–Z a–z 0–9 _ -. The first twelve characters (edk_ plus the first eight) are the key's display prefix, shown in the portal so you can identify a key without seeing its secret.

Key lifecycle

Create a key in the portal. The full secret is returned exactly once, at creation. We store only its SHA-256 hash, so we cannot show it again and a database leak exposes no usable secret.
Rotate by creating a new key, switching your integration to it, then revoking the old one. There is no separate rotate action: rotation is create-then-revoke.
Revoke a key in the portal at any time. A revoked key stops working immediately and returns invalid_api_key. Revoked keys stay listed for audit with their revocation date.

Multiple keys

You can hold several active keys at once (up to a generous per-account limit), which is what makes zero-downtime rotation possible. Use a distinct key per environment or service so you can revoke one without affecting the rest.

Who can use the API

A key authenticates, but entitlement decides whether it can serve data. The rules:

Connect accounts are entitled while their status is sandbox or active. The free sandbox tier is fully usable; connecting a real bank moves you to active once billing is set up.
Existing Endute app subscribers are entitled while their subscription is active or trialing (API access is included with the app plan).
Anything else, such as a lapsed subscription or a failed renewal payment, returns a 403 with subscription_lapsed. After a failed payment the message says so and asks you to update your payment details. The key is not revoked, so access resumes automatically once you have paid.

Error responses

Authentication and entitlement failures use the standard error envelope with a machine-readable code you can branch on:

401 Unauthorizedjson

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid or revoked API key."
  }
}

403 Forbiddenjson

{
  "error": {
    "code": "subscription_lapsed",
    "message": "Your subscription has lapsed. API access resumes when it is renewed."
  }
}

Code	HTTP	Meaning
not_authenticated	401	No Authorization header was sent.
invalid_api_key	401	The header was malformed, or the key is unknown or revoked.
user_inactive	401	The account that owns the key is disabled.
subscription_lapsed	403	The key is valid but the subscription is not currently entitled: it has lapsed, or a renewal payment failed. Renew, or update your payment details, to resume; the key is not revoked.
demo_account	403	Demo accounts cannot use the API.
connect_not_available	403	Endute Connect is not currently available for this account.

See Pagination & errors for the full envelope and throttling behaviour.

Scanning for leaked keys

Because keys have a fixed shape, you can scan your own code, logs and history for accidental exposure. The pattern to search for is:

regex

edk_[A-Za-z0-9_-]{8}_[A-Za-z0-9_-]{43}

If you find a leaked key, revoke it in the portal immediately and create a replacement. If you believe a key has been used by someone else, revoke it and contact us so we can help review the usage window.