API Personal Protektor

Endpoint

Método que se utiliza para realizar consultas de datos personales (consulta de historial personal de actividades ilícitas) dentro del sistema Personal Protektor. Recibe información del solicitante y del solicitado, valida los datos proporcionados (como tipo de identificación y fecha de expedición), y envía una notificación por correo.

POST

/api/search_personalprotektor

Body - Content type: application/json

                                        

    {
        "requester": {
            "identification_type": "",
            "identification": "",
            "expedition_date": ""
        },
        "requested": {
            "identification_type": "",
            "identification": "",
            "expedition_date": ""
        },
        "email_notify": "",
        "is_personal": true
    }

Tablas de referencia

✭ "requester"

Objeto con los detalles de la persona que realiza la consulta.

· "identification_type"

string, requerido, debe ser "CC" o "NIT"

· "identification"

string, requerido

· "expedition_date"

string, requerido, formato: DD/MM/YYYY

✭ "requested"

Objeto con los detalles de la persona a consultar.

· "identification_type"

string, requerido, debe ser "CC" o "NIT"

· "identification"

string, requerido

· "expedition_date"

string, requerido, formato: DD/MM/YYYY

✭ "email_notify"

string, requerido, correo electrónico del requester

✭ "is_personal"

boolean, requerido, por defecto: true

Ejemplo Headers

Ejemplo Body

Respuestas

✓ EXITOSO

200

                                        

    {
        "status": "sending",
        "request_id": "123e4567-e89b-12d3-a456-426614174000"
    }

La solicitud se procesó correctamente.

✕ ERRORES

400

    {
        "error": "Datos inválidos",
        "details": {
            "requester.identification_type": "Debe ser 'CC' o 'NIT'.",
            "requester.expedition_date": "Debe estar en formato DD/MM/YYYY."
        }
    }

Bad Request

500

                                        

    {
        "error": "Ocurrió un error inesperado. Por favor, intenta nuevamente más tarde."
    }

Internal Server Error

Pruebas

Puedes probar la API utilizando herramientas como Postman o cURL. Asegúrate de incluir el token de acceso en los headers de tu solicitud.

Aquí tienes un ejemplo usando cURL:

                                

    curl -X POST https://dataprotektor.com/api/search_personalprotektor/ \
    -H "Content-Type: application/json" \
    -H "X-Api-Key: TU_CLAVE_API" \
    -d '{
        "requester": {
            "identification_type": "CC",
            "identification": "123456789",
            "expedition_date": "01/01/2000"
        },
        "requested": {
            "identification_type": "CC",
            "identification": "987654321",
            "expedition_date": "01/01/2000"
        },
        "email_notify": "mail@domain.com",
        "is_personal": true
    }'

Notas

El endpoint /api/search_personalprotektor es el único disponible en esta versión de la API.
El token de acceso es esencial para autenticar las solicitudes y debe ser incluido en los headers de cada petición.
Los valores permitidos para identification_type son únicamente "CC" y "NIT".
La Fecha de Expedición (expedition_date) deben seguir el formato DD/MM/YYYY para asegurar la correcta interpretación por parte del sistema.
Asegúrate de incluir todos los campos requeridos y formateados correctamente en el cuerpo de la solicitud.

¿Necesitas ayuda?

Puedes ingresar a personalprotektor para obtener más información sobre el proceso a través de sencillos pasos que te guiarán a realizar la consulta de historial personal de actividades ilícitas de manera efectiva.

Si tienes alguna pregunta o necesitas asistencia técnica, no dudes en ponerte en contacto con nuestro equipo a través del correo alejandra.perez@amlprotektor.com