● METODO DE AUTENTICACION
El primer paso es obtener el token para realizar la autenticación como usuario. Esto se realiza mediante un request, apuntando al
endpoint https://api.dev.latam.equifax.com/v2/oauth/token
La estructura del request es la siguiente:
Header:
Host: api.dev.latam.equifax.com
Content-Type: application/x-www-form-urlencoded
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Content-Length: el valor correspondiente al request enviado
VARIABLE VALOR
scope https://api.latam.equifax.com/business/integration-api-efx/v1
grant_type client_credentials
EJEMPLO DE REQUEST HTTP:
POST /v2/oauth/token HTTP/1.1
Host: api.dev.latam.equifax.com
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/x-www-form-urlencoded
Content-Length: 109
scope=https%3A%2F%2Fapi.latam.equifax.com%2Fbusiness%2Fintegration-api-efx%2Fv1&grant_type=client_credentials
La respuesta obtenida será el Token necesario para validarse en las llamadas posteriores, y así poder hacer uso de nuestros
servicios
Ejemplo del response de solicitud de Token:
{
"access_token": "zr16O8rvKRtUiooSreSGiv",
"token_type": "Bearer",
"expires_in": 1449,
"scope": "https://api.latam.equifax.com/business/integration-api-efx/v1"
}
VARIABLES EN EL RESPONSE
access_token Token de acceso, el cual nos va a permitir acceder a los distintos endpoints del
servicio.
token_type Descripción del tipo del Token.
expires_in Validez del Token (en segundos)
scope Rol de usuario que está consumiendo el servicio.
● REALIZAR CONSULTAS
Las consultas deben realizarse apuntando al siguiente endpoint:
https://api.dev.latam.equifax.com/business/integration-api-efx/v1/wserv
Header:
Host: api.dev.latam.equifax.com
Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json
Content-Length: el valor correspondiente al mensaje enviado
VARIABLES CONFIGURABLES
NOMBRE DE LA VARIABLE EXPLICACION
documento Número del documento a consultar(solo dígitos sin puntos)
nombre Nombre de la persona física o jurídica a consultar (opcional)
Género de la persona a consultar. Las opciones son Masculino (M) -
sexo Femenino (F) - Indefinido (I) - Sociedad (S) y No Binario (X) - Busqueda (B)
Se debe configurar el sector que corresponde al producto a consultar. El
sector mismo se detalla en el mail que le fue enviado, junto con las credenciales
necesarias.
billTo Se debe configurar su número de cliente (otorgado por EQUIFAX)
shipTo Identifica el centro de costo para la facturación (por defecto es 0)
Indica el formato con el cual se desea recibir el informe. Los posibles
formatReport valores son T (texto) o H (HTML)
Las opciones son “experto”, si solo se desea obtener el resultado de
producto InterConnect; y “Risc:experto”, si se desea obtener el informe Risc +
InterConnect
Es un campo libre de 32 caracteres, que solo acepta caracteres
alfanuméricos. Puede ser utilizado a conveniencia del usuario, por ejemplo,
clienTxId el número de legajo del consultante, un número de operación, etc. No
puede viajar vacío.
variables Permite la configuración de variables de entrada adicionales para la
consulta, en el caso de que el modelo establecido las permita
globalVariables Permite la configuración de variables globales para todos los integrantes
de la consulta.
EJEMPLO DE CONSULTA (UN INTEGRANTE)
{
"applicants": {
"primaryConsumer": {
"personalInformation": {
"entity": {
"consumer": {
"names": [
{
"data": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "M"
}
}
]
}
},
"productData": {
"sector": "XX",
"billTo": "XXXXXXX",
"shipTo": "X",
"formatReport": "X",
"producto": "XXXXXXXX"
},
"clientConfig": {
"clientTxId": "XXXXXX",
"clientReference": ""
},
"variables": {},
"globalVariables": {},
"vinculos": []
}
}
}
}
EJEMPLO DE RESPONSE (UN INTEGRANTE)
{
"clientImplementationStatus": "completed",
"loteFecha": "XXXXXXXX",
"loteUsuCodigo": "XXX",
"loteNum": "XXXX",
"applicants": [
{
"SMARTS_RESPONSE": {
"variablesDeEntrada": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "X"
},
"VariablesDeSalida": {
"poblacion": "X",
"score_veraz": "XXX",
"scorecard_score3": "XXXX"
}
}
}
],
"SMARTS_CONSOLIDADO_RESPONSE": [
{
"integrantes": [
{
"variablesDeEntrada": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "X"
},
"VariablesDeSalida": {
"poblacion": "XX",
"score_veraz": "XXX",
"scorecard_score3": "XXXXXXX"
}
}
],
"AtributosGlobales": {}
}
],
"REPORTE_RESPONSE": [
{
"formato": "H",
"Data": EN CASO DE CONTAR CON EL PRODUCTO RISC:EXPERTO, EN ESTA SECCIÓN SE ENCONTRARÁ EL INFORME
EN EL FORMATO QUE HAYA SIDO SELECCIONADO (TEXTO O HTML)
}
],
"clientImplementationUUID": "0",
"clientImplementationDateCreated": "",
"clientImplementationDateModified": ""
EJEMPLO DE CONSULTA (MÚLTIPLES INTEGRANTES)
En el caso de consultar múltiples registros, se deben agregar los mismos repitiendo la estructura principal del request, pero
diferenciando cada integrante.. En el siguiente ejemplo denominamos “primaryConsumer1” a la consulta del segundo integrante:
{
"applicants": {
"primaryConsumer": {
"personalInformation": {
"entity": {
"consumer": {
"names": [
{
"data": {
"documento": "XXXXXXXXXX",
"nombre": "APELLIDO Y NOMBRE",
"sexo": "X"
}
}
]
}
},
"productData": {
"sector": "XX",
"billTo": "XXXXXX",
"shipTo": "X",
"formatReport": "X",
"producto": "XXXXXXXX"
},
"clientConfig": {
"clientTxId": "primaryConsumer",
"clientReference": ""
},
"variables": {},
"globalVariables": {},
"vinculos": []
}
},
"primaryConsumer1":{
"personalInformation": {
"entity": {
"consumer": {
"names": [
{
"data": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO Y NOMBRE",
"sexo": "X"
}
}
]
}
},
"productData": {
"sector": "XX",
"billTo": "XXXXXX",
"shipTo": "X",
"formatReport": "X",
"producto": "XXXXXXXXXX"
},
"clientConfig": {
"clientTxId": "primaryConsumer1",
"clientReference": ""
},
"variables": {},
"globalVariables": {},
"vinculos": []
}
}
}
}
EJEMPLO DE RESPONSE (MÚLTIPLES INTEGRANTES)
"clientImplementationStatus": "completed",
"loteFecha": "XXXXXXXX",
"loteUsuCodigo": "XXX",
"loteNum": "XXXX",
"applicants": [
{
"SMARTS_RESPONSE": {
"variablesDeEntrada": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "X"
},
"VariablesDeSalida": {
"poblacion": "XX",
"score_veraz": "XXX",
"scorecard_score3": "XXXX"
}
}
},
{
"SMARTS_RESPONSE": {
"variablesDeEntrada": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "X"
},
"VariablesDeSalida": {
"poblacion": "XX",
"score_veraz": "XXX",
"scorecard_score3": "XXXXXX"
}
}
}
],
"SMARTS_CONSOLIDADO_RESPONSE": [
{
"integrantes": [
{
"variablesDeEntrada": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "X"
},
"VariablesDeSalida": {
"poblacion": "XX",
"score_veraz": "XXX",
"scorecard_score3": "XXXXX"
}
},
{
"variablesDeEntrada": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "X"
},
"VariablesDeSalida": {
"poblacion": "XX",
"score_veraz": "XXX",
"scorecard_score3": "XXXXXX"
}
}
],
"AtributosGlobales": {
"Es Global": "XXX"
}
}
],
"REPORTE_RESPONSE": [
{
"formato": "H",
"data": EN CASO DE CONTAR CON EL PRODUCTO RISC:EXPERTO, EN ESTA SECCIÓN SE ENCONTRARÁ EL INFORME
DEL PRIMER INTEGRANTE, EN EL FORMATO QUE HAYA SIDO SELECCIONADO (TEXTO O HTML)
},
{
"formato": "H",
"data": EN CASO DE CONTAR CON EL PRODUCTO RISC:EXPERTO, EN ESTA SECCIÓN SE ENCONTRARÁ EL INFORME
DEL SEGUNDO INTEGRANTE, EN EL FORMATO QUE HAYA SIDO SELECCIONADO (TEXTO O HTML)
}
],
"clientImplementationUUID": "primaryConsumer",
"clientImplementationDateCreated": "",
"clientImplementationDateModified": ""
}
VARIABLES ADICIONALES
En caso de que el funcional de InterConnect contenga mayores variables a las standard (DNI, sexo y nombre), las mismas se
deberán especificarse dentro de “Variables”. Por ejemplo, si el cliente tiene como variables adicionales “provincia”, “fecha de
nacimiento”, “fecha de ingreso” e “ingreso_neto_mensual_1”, se estructuraran de la siguiente manera:
{
"applicants": {
"primaryConsumer": {
"personalInformation": {
"entity": {
"consumer": {
"names": [
{
"data": {
"documento": "XXXXXXXX",
"nombre": "APELLIDO, NOMBRE",
"sexo": "M"
}
}
]
}
},
"productData": {
"sector": "XX",
"billTo": "XXXXXX",
"shipTo": "X",
"formatReport": "X",
"producto": "XXXXXXXXX"
},
"clientConfig": {
"clientTxId": "XXXXXXXX",
"clientReference": ""
},
"variables": {
"provincia": "17",
"fecha_nacimiento": "29/07/1994",
"fecha_de_ingreso": "01/02/2014",
"ingreso_neto_mensual_1": "98500",
"ingreso_neto_mensual_2": "96000"
},
},
"globalVariables": {},
"vinculos": []
}
}
}
}
