PEPS Generate Report

Descripción del Endpoint

Este endpoint permite validar personas en una lista de prevención de lavado de dinero y financiamiento del terrorismo. Se utiliza para verificar si una persona está en la lista de personas expuestas políticamente (PEPs).

Método

POST

URL

{{v4_host}}/secure/validate/peps

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser un objeto JSON que contenga la siguiente propiedad:

nombre_completo (string): El nombre completo de la persona que se desea validar.

Ejemplo de Cuerpo de Solicitud

{
  "nombre_completo": "Joaquin Guzman Loera"
}

Respuesta Esperada

La respuesta de este endpoint es un objeto JSON que contiene la siguiente estructura:

data (object): Contiene la información sobre la validación.

code_message (string): Mensaje de código, puede estar vacío.

conteoResultados (integer): Número de resultados encontrados, que indica cuántas coincidencias se encontraron en la lista.

id (integer): Identificador de la consulta, generalmente es 0 si no hay coincidencias.

resultados (array): Lista de resultados de la validación.

activo (boolean): Indica si la entrada está activa.

alias (string|null): Alias de la persona, si aplica.

curp (string|null): CURP de la persona, si aplica.

lista (string): Nombre de la lista en la que se encontró la coincidencia.

nombreCompleto (string): Nombre completo de la persona validada.

pais (string): País asociado a la persona validada.

similitud (number): Porcentaje de similitud en la búsqueda.

tipoLista (string): Tipo de lista en la que se encontró la coincidencia.

message (string): Mensaje adicional sobre la solicitud, puede estar vacío.

success (boolean): Indica si la solicitud fue exitosa.

Ejemplo de Respuesta

{
  "data": {
    "code_message": "",
    "conteoResultados": 0,
    "id": 0,
    "resultados": [
      {
        "activo": true,
        "alias": null,
        "curp": null,
        "lista": "",
        "nombreCompleto": "",
        "pais": "",
        "similitud": 0,
        "tipoLista": ""
      }
    ]
  },
  "message": "",
  "success": true
}

Notas

Un conteoResultados de 0 indica que no se encontraron coincidencias en la lista.

La propiedad resultados puede estar vacía si no hay coincidencias.

Proporciona tu token bearer en el encabezado

Authorization

al realizar solicitudes a recursos protegidos.

Ejemplo:

Authorization: Bearer ********************

curl --location -g --request POST '{{v4_host}}/secure/validate/peps' \ --header 'x-api-key: {{api-key}}' \ --header 'service: {{service}}' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "nombre_completo": "Joaquin Guzman Loera" }'

{ "data": { "code_message": "data_found", "conteoResultados": 5, "id": 5824404956512256, "resultados": [ { "activo": true, "alias": null, "curp": null, "lista": "Procuraduría General de la República", "nombreCompleto": "JOAQUIN GUZMAN LOERA", "pais": "MX", "similitud": 100, "tipoLista": "pgr" }, { "activo": true, "alias": "JOAQUIN ARCHIVALDO GUZMAN LOERA", "curp": null, "lista": "Procuraduría General de la República", "nombreCompleto": "JOAQUIN GUZMAN LOERA", "pais": "MX", "similitud": 100, "tipoLista": "pgr" }, { "activo": true, "alias": "EL CHAPO GUZMAN", "curp": null, "lista": "Procuraduría General de la República", "nombreCompleto": "JOAQUIN GUZMAN LOERA", "pais": "MX", "similitud": 100, "tipoLista": "pgr" }, { "activo": true, "alias": null, "curp": null, "lista": "Procuraduría General de la República", "nombreCompleto": "JOAQUIN GUZMAN LOERA PGR", "pais": "MX", "similitud": 90, "tipoLista": "pgr" }, { "activo": true, "alias": null, "curp": null, "fechaNacimiento": "", "lista": "Funcionarios Públicos Nacionales que no son Peps", "nombreCompleto": "JOAQUIN SUMANO LEYVA", "posicion": "SUPERINTENDENCIA ZONA TUXTLA CFE", "similitud": 80, "tipoLista": "ppf" } ] }, "message": "OK", "success": true }

Descripción del Endpoint#

Método#

URL#

Cuerpo de la Solicitud#

Ejemplo de Cuerpo de Solicitud#

Respuesta Esperada#

Ejemplo de Respuesta#

Notas#

Solicitud

Respuestas