Getting Started

Follow these steps to start calling the eConnect Identities REST API.

1. Request Access and Credentials

The Identities API ships with each Identities deployment. To use it programmatically you need:

• A user account on the target Identities server (username + password).
• A role assigned to that account that grants the permissions for the endpoints you intend to call. See Permissions below and the per-endpoint Minimum Permission notes.

Contact eConnect Support at support@econnect.tv to have an integration account provisioned for your partnership and the correct permissions assigned.

2. Base URL

The base URL differs between cloud and on-premise deployments:

Deployment	Base URL
eConnect Cloud	https://customername.econnectcloud.com/identities
On-premise	https://<server-host-or-ip>:5009

Cloud vs. on-premise paths differ

• Cloud deployments are served behind a reverse proxy under the /identities path prefix.
• On-premise the Identities app listens directly on HTTPS port 5009 (and HTTP port 6009) with no /identities prefix — for example https://10.0.0.123:5009/api/v1/authenticate.

Examples in this guide use the cloud URL https://customername.econnectcloud.com/identities. For on-premise, drop the /identities segment and use the :5009 host, e.g. https://10.0.0.123:5009.

3. Permissions

Endpoints are protected by fine-grained permissions (assigned to Roles, which are assigned to Users under System → System settings in the Identities web app). Permission names below are exactly what you'll see in that UI. The Face Edge endpoints used in this guide require permissions from the Facial Recognition Services category:

Permission	Category	Used by
Face Publishing	Facial Recognition Services	faceEdge/publish, faceEdge/publishWithResponse
Face Recognize	Facial Recognition Services	faceEdge/recognize, faceEdge/lookup

The authenticate endpoint itself is anonymous (any valid account can log in); renewToken only requires a valid JWT.

4. .NET SDK (Optional)

A .NET client SDK wraps authentication (including automatic JWT renewal) and every endpoint:

• Package: eConnect.IdentitiesDbSdk

Private package

eConnect.IdentitiesDbSdk is not published on public NuGet. Request access from eConnect Support at support@econnect.tv. If you'd rather not take a dependency, every example in this guide also includes raw Curl and PowerShell equivalents you can run with no SDK.

The C# examples use the SDK like this:

using eConnect.IdentitiesDbSdk;

var httpClient = new HttpClient();

// Authenticates immediately and keeps the JWT fresh automatically.
var sdk = await IdentityDbSdk.GetSdk(
    "https://customername.econnectcloud.com/identities",
    httpClient,
    "your_username",
    "your_password");

5. OpenAPI / Swagger

It is highly recommended to generate a client from the OpenAPI schema rather than hand-coding requests.

Swagger is not enabled on every instance

Swagger / OpenAPI is disabled by default on each Identities deployment and must be explicitly enabled. For development, eConnect maintains an always-on test instance with Swagger available:

• Swagger UI: https://montana.econnectclouddev.com/identities/swagger/index.html
• Swagger Schema: https://montana.econnectclouddev.com/identities/swagger/v1/swagger.json

Use this test instance to explore the full API and generate a client.

Next Steps

• Authentication — get your JWT.
• Publish With Response — the key Face Edge endpoint.
• API Overview — the full endpoint reference.