Integración Previred (Chile)
/previred
Esta API permite realizar el flujo de integración con Previred.
Las operaciones soportadas son:
Crear transacción: realiza todo el flujo y devuelve el identificador correspondiente.
Obtener Token: devuelve el token asociado a un identificador.
Crear (Create)
Solicitud de inicio de creación de transacción:
bash
curl --location '{IDENTITY_API_BASE_URL}/services/previred' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"customerId": "{CUSTOMER_ID}",
"identityTransactionId": "{IDENTITY_TRANSACTION_ID}",
"documentValidationScanReference": "{DOCUMENT_VALIDATION_SCAN_REFERENCE}",
"ipVerified": "{IP_VERIFIED}",
"callbackUrl": "{CALLBACK_URL}"
}'Parámetros de la solicitud:
Campo
Requerido
Descripción
CUSTOMER_ID
Sí
ID de cliente asignado a la institución que consulta
IDENTITY_TRANSACTION_ID
Sí
Identificador resultante de llamar a /v2/identity
DOCUMENT_VALIDATION_SCAN_REFERENCE
Sí
Identificador resultante de llamar a /verify/documentValidation/v2/start
IP_VERIFIED
Sí
Dirección IP del punto de verificación de identidad
CALLBACK_URL
No
URL de callback opcional
Ejemplo de respuesta:
200 OK
Content-Type: application/json
json
Campos de la respuesta:
Campo
Descripción
timestamp
Hora Unix de la respuesta en segundos
transactionId
ID de transacción vinculado al proceso de generación de evidencias
hash
Datos informativos. Cadena de control para el mensaje recibido por el servicio
Evento de Callback
Si se ha especificado una URL de callback, se enviará una solicitud con el resultado al finalizar el proceso.
Content-Type: application/json
json
Campos de la respuesta:
Campo
Descripción
timestamp
Hora Unix de la respuesta en segundos
transactionId
ID de transacción vinculado al proceso de generación de evidencias
statusCode
Código de estado HTTP
status
Estado final de la transacción (succeeded - exitoso o failed - fallido)
Token (Get Token)
Solicitud de obtención de token:
bash
Parámetros de la solicitud:
Campo
Requerido
Descripción
TRANSACTION_ID
Sí
ID de transacción devuelto por /services/previred después de una llamada exitosa
Ejemplo de respuesta:
200 OK
Content-Type: application/json
json
Campos de la respuesta:
Campo
Descripción
timestamp
Hora Unix de la respuesta en segundos
transactionId
ID de transacción vinculado al proceso de generación de evidencias
token
Token de autenticación TVI
url
URL para descargar el PDF de las evidencias de verificación
Last updated