Saltar al contenido principal
cURL
curl -X POST https://api.origoid.com/global/compliance/v1/ofac-searches \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "name": "Abu Sufian al-Salamabi Muhammed Ahmed Abd al-Razziq",
    "passportNumber": "BC166787"
  }'
{
  "status": "OK",
  "type": "SUCCESS",
  "message": "No OFAC matches found",
  "data": {
    "matchFound": false,
    "riskLevel": "NONE",
    "totalMatchesFound": 0,
    "matches": []
  },
  "transactionId": "9041aa05-782b-461e-9033-5e07b2ad55fc",
  "processedAt": "2026-03-19T10:00:00-06:00",
  "billable": true
}

Autorizaciones

x-api-key
string
header
requerido

Cuerpo

application/json
name
string
requerido

Full name of the individual or Legal Name of the entity. Required.

Ejemplo:

"JOAQUIN GUZMAN LOERA"

passportNumber
string

Passport number, normalised (trimmed, uppercase). Optional. Exact match against a record's passport ID is a strong signal — adds 5 to the score and is reported in matchedOn.identifiersMatched. A mismatch drops the score by 20.

Ejemplo:

"G01234567"

nationalIdNumber
string

National identifier as published by OFAC — typically National ID, Cedula, RFC, SSN, or Tax ID depending on jurisdiction. Optional. Normalised (trimmed, uppercase). Exact match adds 5 to the score; mismatch drops 20. OFAC does not publish CURP, and RFC appears only on a handful of records, so for Mexican subjects this field is usually neutral. Highest practical value is for cross-border screening of foreign counterparties.

Ejemplo:

"BC166787"

minSimilarityScore
integer
predeterminado:90

Minimum similarity score required to return a fuzzy match. Defaults to 90 — a conservative threshold tuned to suppress common-name false positives. 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 final score after multi-identifier boosts and penalties is the value compared against this threshold.

Rango requerido: x <= 100

Respuesta

OFAC 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.