Blacklist Search API (stable)
Download OpenAPI specification:Download
Búsqueda de posibles coincidencias de personas y entidades en listas nacionales e internacionales.
Búsqueda en listas
Busca posibles coincidencias en todas las listas disponibles o en las listas seleccionadas.
Authorizations:
apiKey
Request Body schema: application/json
required | string or object |
| lists | Array of strings (BlacklistKey) non-empty unique Items Enum: "bid" "atf" "usm" "itp" "dea" "bam" "boe" "bsn" "apa" "dtc" "bis" "pgj" "ssi" "fse" "ppi" "epa" "pis" "lmw" "fps" "not" "cor" "don" "satb" "sat" "dfa" "ppf" "ppx" "ice" "cia" "fbi" "ofc" "kpn" "pgr" "onu" "ppe" "pap" "mem" "eun" "pcs" Busqueda especifica en ciertas listas |
| fuzziness | boolean Default: false Activa coincidencias tolerantes a variaciones ortográficas. Su efecto depende de los campos enviados. |
| min_similarity | number [ 0 .. 1 ] Default: 0.8 Similitud mínima de los resultados. El valor 0 activa el umbral automático del servicio. |
Responses
Request samples
- Payload
Content type
application/json
{- "query": "Persona de Ejemplo",
- "lists": [
- "ppi",
- "ofc"
], - "fuzziness": false,
- "min_similarity": 0.8
}Response samples
- 200
- 400
- 500
Content type
application/json
{- "status": true,
- "min_score": 0.92,
- "max_score": 0.92,
- "result": [
- {
- "similarity": 0.8,
- "list": {
- "name": "PEPS Internacionales",
- "key": "bid"
}, - "score": 0.92,
- "ranking": 1.2,
- "alias": null,
- "created_at": "2021-10-01T00:00:00Z",
- "tax_id": "ABCDEF123456AB0",
- "payload": {
- "address": "",
- "country": "AUSTRALIA",
- "regulation": "APRA"
}, - "curp": null,
- "full_name": "PERSONA DE EJEMPLO",
- "active": true
}
]
}
