Identities REST API
Program against the eConnect Identities platform directly. Authenticate with a username and password to receive a
JWT, then call the public REST endpoints to publish faces from edge detectors, recognize and look up identities,
and manage people, tags, and detections. This guide focuses on the Face Edge endpoints — including
publishWithResponse — with runnable examples you can use to validate your integration.
What This API Does
The Identities REST API is the programmatic entry point to an eConnect Identities server. Edge face detectors and partner systems use it to push detected faces into the facial-recognition engine and to resolve those faces back to enrolled people.
Exchange a username and password for a JWT bearer token, then renew it before it expires.
Send a detected face to the FR engine and synchronously get back the matched faces, scores, and bounding boxes.
Match a cropped/aligned face — or precomputed embeddings — against enrolled identities.
Read and edit people, aliases, tags, notes, custom fields, and query face detections.
This is the developer / API guide. For the Identities web application — searching, the Live Monitor, collections, and publish/subscribe — see the Identities User Guide.
Documentation
Request access, find your base URL, install the .NET SDK, and locate the OpenAPI schema.
Log in with a username and password to obtain a JWT, and renew it before it expires.
The key endpoint — publish a detected face and synchronously receive the detection results.
Swagger links plus a reference table of every public REST endpoint, grouped by controller.
Sequence diagrams for the authentication flow and the publishWithResponse request lifecycle.
Push face detections from another site's Events Bridge, or your own system, into Identities with a source key.