# Navarik Bridge HTTP API

# API support

The APIs documented on this site are officially supported by Navarik, unless they are marked as deprecated. Don't consume any Bridge API unless the API is documented on this site. You should consider all undocumented endpoints private, subject to change without notice, and not covered by any agreements.

# URL Namespace

Precede all URLs listed in the documentation with Navarik provided environment URL and API version.

Supported environments:

  • https://api.navarik.com/bridge/ - production environment.
  • https://api.uat.navarik.com/bridge/ - user acceptance testing (UAT) environment for testing Navarik products with persistent user-created data.

# Version guidelines

The Bridge API is a versioned API. Navarik reserves the right to add new parameters, properties, or objects to the API without advance notice.

Currently supported versions:

  • /v1 - Bridge Version 1, deprecated and scheduled to be removed on May 31, 2022.
  • /v2 - Bridge Version 2. In active support and development. New features are regularly added to this version.

# Authentication

The Bridge API uses Bearer API tokens to authenticate requests. Identity information is provided to the APIs via Authorization header.

Example:

Authorization: Bearer eyJhbGciOiJS...

See Navarik ID Authentication for details.

# Media types

The API currently supports XML and JSON as exchange formats. Desired format can be specified using Accept request header.

All Date objects are returned in ISO 8601 format (opens new window): YYYY-MM-DDTHH:mm:ss.SSSZ