Overview

Introduction

Flow overview

Requirements

Versionning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Outgoing APIs

Overview

Callback authentication (HMAC)

Response protocol

Callback types

Reference

Changelog

API versioning

When backwards-incompatible changes are made to the API, a new, dated version is released.

The latest version is 2026-03-23.

Targeting a specific version

Via header (recommended)

Add the X-Nabla-Api-Version header to any request:

curl <https://us.api.nabla.com/{endpoint}> -H "X-Nabla-Api-Version: 2026-03-23"

Via query parameter

Alternatively, use the nabla-api-version query parameter:

curl <https://us.api.nabla.com/{endpoint}?nabla-api-version=2026-03-23>

Base URL

The <baseUrl> for all APIs is:

https://<region>.api.nabla.com/v1/connect/server

Where <region> is us or eu.