For the complete documentation index, see llms.txt. This page is also available as Markdown.

INE Service

Facephi INE Service It is a REST API service in C++ that allows performing Identity Verification through Facial Recognition. The service is based on the SelphID SDK, technology developed by FacePhi. It implements the Mexipay-INE (National Electoral Institute) specification of Mexico.

The service exposes the following endpoints:

  • POST /api/v1/facial/authentication

  • GET /api/v1/health

  • GET /api/v1/version

The supported image formats are:

  • INE (0)

  • JPEG (1)

  • TEMPLATE RAW (2)

  • BEST IMAGE Token (3)

The main distribution of the service is a Docker container based on Ubuntu 26.04.

JWT authentication

JWT authentication is optional and disabled by default.

  • It is configured when the service starts in config.json with auth_enabled, auth_jwt_secret, auth_accept_authorization_header, auth_accept_api_key_header and auth_api_key_header_name.

  • The same values can be overridden with the environment variables FACEPHI_INE_REST_AUTH_*.

  • GET /api/v1/health and GET /api/v1/version remain public.

  • POST /api/v1/facial/authentication requires a valid JWT when authentication is enabled.

  • The service does not expose endpoints GET/POST /config at runtime, so JWT configuration can only be set at startup.

Last updated