Authentication


To use the Hyfin API, you need to be an approved partner with an API token. To request a token, email our API Support team at api-support@hyfin.app .


Request Header

Send your API token in the x-access-token header of every request, as shown below. Replace API_TOKEN_VALUE with your token.

x-access-token: API_TOKEN_VALUE

A request that arrives without a token is rejected with HTTP 401 and Unauthorized access, and one whose token cannot be read is rejected with HTTP 401 and Session expired, please sign in again.


API Access

A valid token is not enough on its own. Each site you call must also have the API Access feature turned on. If it is not, your first request to that site returns this error:

Feature integrations.hyfin_api_access is not available for Site {site_id}

That error means your token and request are fine, and only API Access is missing. Hyfin turns it on for each site, so ask your representative or the API Support address above.