Saltar al contenido principal
cURL
curl -X POST https://api.origoid.com/mex/compliance/v1/peps-searches \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"givenNames": "ANDRES MANUEL", "firstSurname": "LOPEZ", "secondSurname": "OBRADOR", "nationalIdNumber": "LOOA531113HTCPBN07"}'
{
  "status": "OK",
  "type": "SUCCESS",
  "message": "No PEPs matches found",
  "data": {
    "matchFound": false,
    "riskLevel": "NONE",
    "totalMatchesFound": 0,
    "matches": []
  },
  "transactionId": "d2b0b572-0be8-4744-bf0d-72f21135125b",
  "processedAt": "2026-03-19T10:05:00-06:00",
  "billable": true
}

Autorizaciones

x-api-key
string
header
requerido

Cuerpo

application/json
name
string
requerido

Full name of the subject (single string). Optional alternative to the split givenNames / firstSurname format. Use this when you only have the full name as one value (form input, OCR extraction). For best match quality, prefer the separated fields below.

Ejemplo:

"ANDRES MANUEL LOPEZ OBRADOR"

givenNames
string

Subject's given name(s). Use together with firstSurname for the most precise matching. Recommended over the single name field whenever the components are available.

Ejemplo:

"ANDRES MANUEL"

firstSurname
string

Subject's first (paternal) surname. Use with givenNames for best match quality.

Ejemplo:

"LOPEZ"

secondSurname
string

Subject's second (maternal) surname. Optional.

Ejemplo:

"OBRADOR"

nationalIdNumber
string

National identifier — CURP (18 chars) or RFC (12-13 chars). Optional. Normalised (trimmed, uppercase). When provided, it is reported back per match in matchedOn.identifiersMatched and in the standalone identifierMatch field so the reviewer can audit the precision of the hit. Examples: LOOA531113HTCPBN07 (CURP), LOOA531113FI5 (RFC).

Ejemplo:

"LOOA531113HTCPBN07"

minSimilarityScore
integer
predeterminado:70

Minimum similarity score required to return a match. Defaults to 70 — a balanced threshold for PEP screening. Lower it for broader recall when manual review is in place; raise it for stricter automated approval. There is no enforced floor — you can request very low thresholds, but the lower you go the noisier the response will be. The threshold is compared against the combined name + identifier similarityScore (see the description), so a search by nationalIdNumber alone with an exact match is not filtered out even though no name was provided to compare.

Rango requerido: x <= 100

Respuesta

PEP search results (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

Response payload. null on error responses. Shape depends on the endpoint — see each operation's response schema.

errors
object[]

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