​
Base URLs

hConnect provides separate environments for testing and production: 
# Sandbox Environment (Testing)
API_BASE_URL=https://sandbox.connect.hopae.com/api
VERIFY_URL=https://sandbox.verify.hopae.com

​
Environments

hConnect provides separate Sandbox and Production environments for development and live operations.

Environment Details

View complete environment comparison, URLs, and configuration details

​
Authentication

Most API endpoints require Basic Authentication using your Client ID and Client Secret:

​
Basic Authentication

curl -X GET https://sandbox.connect.hopae.com/api/v1/providers \
  -u "CLIENT_ID:CLIENT_SECRET"
Exception: The /v1/token endpoint does NOT require authentication headers. The Client ID and Secret are sent in the request body instead:
{
  "grant_type": "authorization_code",
  "code": "auth_abc123",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET"
}

​
API Versioning

The current API version is v1. The version is included in the URL path: 
https://sandbox.connect.hopae.com/api/v1/[endpoint]
We maintain backward compatibility within major versions. Any breaking changes will be introduced in a new version (e.g., v2).

​
Request Headers

HeaderValueDescription
AuthorizationBasic <base64(client_id:client_secret)>Your API credentials
Content-Typeapplication/jsonRequired for POST/PUT requests

​
Need Help?

Get Providers

List available eID providers

Create Verification

Start a new verification session

Exchange Token

Exchange code for user data

Quickstart Guide

5-minute integration tutorial