Saltar al contenido principal
cURL
curl -X POST https://api.origoid.com/global/biometrics/v1/face-matches \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"face": "string", "front": "string"}'
{
  "status": "OK",
  "type": "SUCCESS",
  "message": "Faces match",
  "data": {
    "faceMatchScore": 96.4,
    "isMatch": true,
    "thresholdApplied": 90,
    "detectedDocumentType": "INE",
    "selfieAnalysis": {
      "imageQuality": "excellent",
      "detectionConfidence": "high",
      "orientation": "front",
      "eyesOpen": true,
      "mouthOpen": false,
      "wearingGlasses": false,
      "wearingSunglasses": false,
      "faceCovered": false,
      "issues": []
    }
  },
  "transactionId": "5c9e1f2a-3b4c-4d5e-6f7a-8b9c0d1e2f3a",
  "processedAt": "2026-06-05T11:20:33.482-06:00",
  "billable": true
}

Autorizaciones

​
x-api-key
string
header
requerido

Cuerpo

application/json
​
face
string
requerido

Face image (selfie) in Base64 (PNG/JPG)

​
front
string
requerido

Front ID image in Base64 (PNG/JPG). Can be any official document globally.

​
threshold
integer
predeterminado:90

Acceptance threshold (1-100). Default: 90 (KYC-grade). Lower (e.g. 80) is more permissive; higher is stricter. Overridable per request.

Rango requerido: 1 <= x <= 100
​
documentType
enum<string>

Optional. Use a specific type (e.g. INE, MEX_PASSPORT) for strict validation against that exact document type. Use ANY to require the image be some recognized ID (auto-detected) — returns NO_DOCUMENT_DETECTED if not. Omit it to skip document validation.

Opciones disponibles:
IFE,
INE,
MEX_PASSPORT,
MEX_RESIDENCE_CARD,
MEX_PROFESSIONAL_ID,
ANY

Respuesta

Biometric analysis result (Strict Envelope Pattern).

​
status
enum<string>
requerido

High-level outcome. OK means the request was successfully processed (regardless of business result). ERROR means the request was rejected or could not be processed.

Opciones disponibles:
OK,
ERROR
​
type
string
requerido

Stable result type code. Includes generic codes (SUCCESS, INVALID_REQUEST, UNAUTHORIZED, SERVICE_UNAVAILABLE, INTERNAL_ERROR, RATE_LIMIT_EXCEEDED) plus endpoint-specific result codes — see this endpoint's response examples.

​
message
string
requerido

Human-readable summary of the result. Always in English (per Language Conventions in the API overview).

​
transactionId
string<uuid>
requerido

Unique identifier of this request, generated by the API Gateway. Propagated end-to-end for traceability.

​
processedAt
string<date-time>
requerido

ISO 8601 datetime with Mexico City offset (-06:00). Always set by the API Gateway when the response leaves the system.

​
billable
boolean
requerido

Whether this request will be charged against the client's plan. Typically true for successful business results and false for validation errors or system errors that prevented processing.

​
data
object

Face-match result. Null for INVALID_REQUEST and INTERNAL_ERROR.

​
errors
object[]

Per-field error details. Present only on INVALID_REQUEST responses.