Documentación de la API - SCA Screening API

Lexia Screening API

API para verificar si los nombres proporcionados se encuentran en listas de control específicas.

Versión: 1.0.0

Servidor

URL: https://lexiacumplimiento.com.py/wp-json

Descripción: Servidor principal donde se aloja la API.

Descripción General

La **SCA Screening API** permite verificar si los nombres de clientes están presentes en listas de control específicas. Puedes realizar consultas individuales o en lotes de hasta 10 nombres por solicitud. Es ideal para integrar en sistemas que requieran validaciones de cumplimiento en tiempo real.

Limitaciones y Uso

  • Máximo de nombres por consulta: 10 nombres.
  • Tipos de consultas: Puedes consultar nombres individualmente o en lotes de hasta 10 nombres.
  • Límite de consultas: 50 consultas cada 5 minutos por clave de API.
  • Formato de nombres: Acepta nombres en formato de cadena de texto.

Es importante respetar los límites de tasa para evitar bloqueos temporales. Asegúrate de manejar adecuadamente las respuestas de error para implementar reintentos con backoff exponencial si es necesario.

Endpoints

POST /sca-screening-api/v1/verify

Resumen: Verifica una lista de clientes.

Descripción: Este endpoint verifica si los nombres proporcionados están en una lista de control específica. Puedes enviar hasta 10 nombres por solicitud, ya sea individualmente o en lotes.

Operation ID: verifyCustomers

Parámetros

Nombre Ubicación Requerido Descripción Tipo Ejemplo
X-API-KEY Header Sí Clave de autorización para acceder al endpoint. string 2c0c2f9aa2b476ef7b4fd53c535041

Cuerpo de la Solicitud

Descripción: Lista de nombres de clientes a verificar. Puedes enviar hasta 10 nombres por solicitud.

Propiedad Tipo Descripción Ejemplo
customer_list array de strings Lista de nombres de clientes a verificar. Máximo 10 nombres por consulta. 
[
    "MUHAMMAD HAMZA ZUBAIDI"
]
 
{
    "customer_list": [
        "MUHAMMAD HAMZA ZUBAIDI"        
    ]
}

Respuestas

200 - Respuesta exitosa

Descripción: La solicitud fue procesada correctamente y se encontraron coincidencias.

Propiedad Tipo Descripción Ejemplo
matches_found integer Número de coincidencias encontradas. 1
matches array de objetos Detalles de las coincidencias encontradas. 
{
    "total_customers": 1,
    "matches_found": 1,
    "matches": [
        {
            "customer_name": "MUHAMMAD HAMZA ZUBAIDI",
            "list_name": "MUHAMMAD HAMZA ZUBAIDI",
            "origen_id": "CLPGE",
            "blk_obs": "Edad: No especificado, Ciudad de Nacimiento: Babylone, Babil (J.O. FR), País de Nacimiento: UNKNOWN, Obs: UNSC RESOLUTION 1483 BASIS. Former Prime Minister",
            "similarity_percentage": 100,
            "match_type": "strict",
            "additional_info": [
                {
                    "list": "Lista de sanciones financieras de la UE.",
                    "data": {
                        "id": "46",
                        "nombre_completo": "MUHAMMAD HAMZA ZUBAIDI",
                        "ciudad_nacimiento": "Babylone, Babil (J.O. FR)",
                        "pais_nacimiento": "UNKNOWN",
                        "fecha_nacimiento": "",
                        "obs": "UNSC RESOLUTION 1483 BASIS. Former Prime Minister",
                        "url_reglamento": "http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2003:169:0006:0023:EN:PDF",
                        "programa": "IRQ",
                        "fecha_publicacion": "2003-07-08",
                        "fecha_actualizacion": "2024-11-21 18:03:59"
                    }
                },
                {
                    "list": "Lista de sanciones de la OFAC.",
                    "data": {
                        "id": "546",
                        "uid": "7851",
                        "nombre_completo": "MUHAMMAD HAMZA ZUBAIDI",
                        "sdn_type": "Individual",
                        "program_list": "IRAQ2",
                        "id_list": null,
                        "aka_list": "a.k.a. (strong): Mohammed Hamza AL-ZUBAIDI; a.k.a. (strong): Muhammad Hamsa AL-ZUBAYDI",
                        "address_list": null,
                        "nationality_list": "Iraq",
                        "citizenship_list": null,
                        "date_of_birth_list": "1938",
                        "place_of_birth_list": "Babylon, Babil Governorate, Iraq",
                        "remarks": "former prime minister",
                        "title": null
                    }
                },
                {
                    "list": "Lista de sanciones de la ONU.",
                    "data": {
                        "id": "317",
                        "dataid": "6908056",
                        "nombre_completo": "MUHAMMAD HAMZA ZUBAIDI",
                        "un_list_type": "Iraq",
                        "reference_number": "IQi.009",
                        "listed_on": "2003-06-27",
                        "comments": "",
                        "nationality": "Iraq",
                        "last_day_updated": "",
                        "address": "",
                        "date_of_birth": "EXACT 1938",
                        "place_of_birth": "Babilonia, Babel   Iraq",
                        "title": "",
                        "designation": "",
                        "alias_name": ""
                    }
                }
            ]
        }
    ],
    "no_matches": 0,
    "summary": {
        "total_customers": 1,
        "matches_found": 1,
        "no_matches": 0
    }
}
 
{
    "total_customers": 1,
    "matches_found": 1,
    "matches": [
        {
            "customer_name": "MUHAMMAD HAMZA ZUBAIDI",
            "list_name": "MUHAMMAD HAMZA ZUBAIDI",
            "origen_id": "CLPGE",
            "blk_obs": "Edad: No especificado, Ciudad de Nacimiento: Babylone, Babil (J.O. FR), País de Nacimiento: UNKNOWN, Obs: UNSC RESOLUTION 1483 BASIS. Former Prime Minister",
            "similarity_percentage": 100,
            "match_type": "strict",
            "additional_info": [
                {
                    "list": "Lista de sanciones financieras de la UE.",
                    "data": {
                        "id": "46",
                        "nombre_completo": "MUHAMMAD HAMZA ZUBAIDI",
                        "ciudad_nacimiento": "Babylone, Babil (J.O. FR)",
                        "pais_nacimiento": "UNKNOWN",
                        "fecha_nacimiento": "",
                        "obs": "UNSC RESOLUTION 1483 BASIS. Former Prime Minister",
                        "url_reglamento": "http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2003:169:0006:0023:EN:PDF",
                        "programa": "IRQ",
                        "fecha_publicacion": "2003-07-08",
                        "fecha_actualizacion": "2024-11-21 18:03:59"
                    }
                },
                {
                    "list": "Lista de sanciones de la OFAC.",
                    "data": {
                        "id": "546",
                        "uid": "7851",
                        "nombre_completo": "MUHAMMAD HAMZA ZUBAIDI",
                        "sdn_type": "Individual",
                        "program_list": "IRAQ2",
                        "id_list": null,
                        "aka_list": "a.k.a. (strong): Mohammed Hamza AL-ZUBAIDI; a.k.a. (strong): Muhammad Hamsa AL-ZUBAYDI",
                        "address_list": null,
                        "nationality_list": "Iraq",
                        "citizenship_list": null,
                        "date_of_birth_list": "1938",
                        "place_of_birth_list": "Babylon, Babil Governorate, Iraq",
                        "remarks": "former prime minister",
                        "title": null
                    }
                },
                {
                    "list": "Lista de sanciones de la ONU.",
                    "data": {
                        "id": "317",
                        "dataid": "6908056",
                        "nombre_completo": "MUHAMMAD HAMZA ZUBAIDI",
                        "un_list_type": "Iraq",
                        "reference_number": "IQi.009",
                        "listed_on": "2003-06-27",
                        "comments": "",
                        "nationality": "Iraq",
                        "last_day_updated": "",
                        "address": "",
                        "date_of_birth": "EXACT 1938",
                        "place_of_birth": "Babilonia, Babel   Iraq",
                        "title": "",
                        "designation": "",
                        "alias_name": ""
                    }
                }
            ]
        }
    ],
    "no_matches": 0,
    "summary": {
        "total_customers": 1,
        "matches_found": 1,
        "no_matches": 0
    }
}
400 - Solicitud inválida

Descripción: La solicitud es inválida, por ejemplo, datos incorrectos o faltantes.

Propiedad Tipo Descripción Ejemplo
error string Descripción del error. "Invalid request format: 'customer_list' exceeds 10 names." 
{
    "error": "Invalid request format: 'customer_list' exceeds 10 names."
}
401 - No autorizado

Descripción: No autorizado, ya sea por clave de API incorrecta o faltante.

Propiedad Tipo Descripción Ejemplo
error string Descripción del error. "Unauthorized: API key is missing or invalid." 
{
    "error": "Unauthorized: API key is missing or invalid."
}
429 - Límite de consultas excedido

Descripción: Se ha excedido el límite de consultas permitidas.

Propiedad Tipo Descripción Ejemplo
error string Descripción del error. "Rate limit exceeded: Maximum 50 requests per 5 minutes." 
{
    "error": "Rate limit exceeded: Maximum 50 requests per 5 minutes."
}
500 - Error interno del servidor

Descripción: Error interno del servidor.

Propiedad Tipo Descripción Ejemplo
error string Descripción del error. "Internal server error." 
{
    "error": "Internal server error."
}

Ejemplos de Uso

Consulta Individual

Envía una solicitud con un solo nombre:

{
    "customer_list": ["Ana Rodríguez Díaz"]
}

Consulta por Lotes

Envía una solicitud con hasta 10 nombres:

{
    "customer_list": [
        "Abel Ham Mahmoud",
        "MoHAMAD AMZA ZUIDI",
        "Juan Martínez Pérez",
        "Ana Rodríguez Díaz",
        "Luis García Jiménez",
        "Carmen López Fernández",
        "José Hernández Ruiz",
        "Laura González Martínez",
        "Miguel Torres Sánchez",
        "Elena Moreno Castro"
    ]
}

Autenticación

Todas las solicitudes a la **SCA Screening API** requieren una clave de API válida. Debes incluir la clave en el encabezado de la solicitud utilizando el parámetro X-API-KEY.

Ejemplo de encabezado:

X-API-KEY: 2c0c2f9aa2b476ef7b4fd53c535041

Información Adicional

Para asegurar el uso eficiente y seguro de la API, ten en cuenta las siguientes recomendaciones:

  • Manejo de Errores: Implementa lógica para manejar respuestas de error adecuadamente, incluyendo reintentos con backoff exponencial en caso de errores temporales como el 500 o el 429.
  • Optimización de Consultas: Agrupa los nombres en lotes de 10 para maximizar la eficiencia de las solicitudes y reducir la cantidad de llamadas a la API.
  • Seguridad: Protege tu clave de API y evita exponerla en el frontend o en repositorios públicos.

© 2024 SCA Screening API. Todos los derechos reservados.