Docs: Authentication

API authentication

Authentication

The banks endpoint is completely free and requires no key. The account resolve endpoint requires an API key passed as a header.

FREE

GET /public/banks

No authentication required. Open to all.

KEY

POST /public/account/resolve

Requires a valid API key in the x-api-key header. Get your key from Integrations.

Passing the API key

header
curl -H "x-api-key: mhk_your_api_key_here" ...
API keys start with mhk_. Generate or revoke yours from your Developer Dashboard. The key is shown only once when created.

Step 1: Go to your Developer Dashboard

From your Myhappr dashboard, navigate to the Developers section in the sidebar. Click Manage on the API Key card to open the key manager.

Myhappr Developers Dashboard showing the API Key card with a Manage button

Step 2: Generate your API key

The API Key drawer shows your active key status. Click Regenerate key to create a new key, it will be displayed once only, so copy it immediately and store it somewhere safe (e.g. an environment variable). Clicking Revoke key permanently invalidates the current key.

Myhappr API Key drawer showing the active key status with Regenerate and Revoke buttons

Keep API keys on your server

The bank-list endpoint needs no API key. Account resolution requires your Myhappr key in the x-api-key header. Store that key in a server environment variable and have your backend make the authenticated request. Do not commit it to a repository, put it in a URL, or bundle it into public browser JavaScript. The playground below is for a deliberate test with your own key; it is not an example of how to distribute credentials to visitors.

Replace a key safely

Copy a newly generated key when it is displayed, then update the environment where your integration runs. Revoking or regenerating credentials requires checking that your application uses the current key. If a request returns Unauthorized, first check that the header is present and that the key has not been revoked. Never paste your secret key into a public issue, support screenshot or analytics event. API-key authentication for banking requests is separate from OAuth access tokens used by connected applications.