API Reference

Biometric REST API for Biomix Face and Biomix ID UITemplate operations. All endpoints accept JSON and return a consistent success / error / data structure.

Base URL

All API requests should be made to the Securbase portal backend:

https://api.securbase.com/portal

Request Format

All requests use POST with Content-Type: application/json and HTTPS. The request body carries the UITemplate and optional parameters.

curl -X POST https://api.securbase.com/portal/biometria/enroll-UI \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"idPersona": "user-123", "template": "UITemplate..."}'

Response Format

Responses return JSON with success, error, and data fields. When success is false, check error.codigo and error.descripcion.

Success Response (200 OK)

{
  "success": true,
  "error": {
    "codigo": 0,
    "descripcion": "string",
    "tipo": "ERROR"
  },
  "data": {
    "status": "SUCCESS",
    "txId": "string"
  }
}

Error Response

{
  "success": false,
  "error": {
    "codigo": 400,
    "descripcion": "Invalid template",
    "tipo": "ERROR"
  },
  "data": null
}

Face UI Endpoints

Endpoints for enrolling, verifying, identifying, extracting face data, and anti-spoof (FAS) verification from UITemplates captured with Biomix Face.

DNI UI Endpoints

Endpoints for extracting Argentine DNI document data from UITemplates captured with Biomix ID.