API de servicios

Tema Anterior
Próximo Tema

Comparador de Nombres

API de servicios Servicios JSON 2.5 Comparador de Nombres

Comparador de Nombres

 

Servicio de Comparador de Nombres (namecomparator)

El cliente debe enviar una estructura de datos debiendo completar mínimamente los campos que se detallan a continuación:

  • leftGender: Género de la primera persona fisica.
  • leftName: Nombre de la primera persona física.
  • leftLastName: Apellido de la primera persona física.
  • rightGender: Género de la segunda persona fisica.
  • rightName: Nombre de la segunda persona física.
  • rightLastName: Apellido de la segunda persona física.

Los siguientes campos son los Headers Obligatorios que deben informarse:

  • Authorization: Header con el ID de acceso de cliente (ClientAccessCode).
  • Content-Type: Header que se informa el tipo de contenido del mensaje, se debe informar application/json.

Método: POST

Endpoint: https://ws.merlindataquality.com/namecomparator/normalize

Parámetros de llamada
Parámetro Descripción Longitud Tipo
Authorization Identificador único de usuarios. Este valor identifica y valida en cada invocación a un usuario determinado. Este valor tiene asociado los roles que le corresponden al usuario. 64 String
Content-Type Header que se informa el tipo de contenido del mensaje, se debe informar application/json. String
leftGender Sexo de la primera persona física. Los valores posibles son: M/F. 64 String
leftLastName Apellido de la primera persona física. 64 String
leftName Nombre de la primera persona física. 64 String
rightGender Sexo de la segunda persona física. Los valores posibles son: M/F. 64 String
rightLastName Apellido de la segunda persona física. 64 String
rightName Nombre de la segunda persona física. 64 String
clientAccessCode Identificador único de usuarios. Este valor identifica y valida en cada invocación a un usuario determinado. Este valor tiene asociado los roles que le corresponden al usuario. 64 String
customAdapters Adaptadores de respuesta/modificadores de comportamiento. 64 String
Mensaje JSON de petición
{
  "leftGender": "",
  "leftLastName": "",
  "leftName": "pablo antonio ferrero gonzalez",
  "rightGender": "",
  "rightLastName": "",
  "rightName": "pablo antonio ferrero gonzalez"
}
Respuesta

La respuesta está compuesta por una lista de elementos que tienen la siguiente estructura:

Parámetro Descripción Longitud Tipo
status

Indica el estado de normalización y/o validación.
Valores Posibles:

    • OK: indica que se pudo realizar la comparación.
    • ERR: Error en los datos ingresados.
    		 3 String
    statusReason

    Indica la razón con referencia al estado de normalización y/o validación.

    Valores posibes:

    • ME: Match Exacto.
    • DS: Distancia existente.
    • NO: Ninguna coincidencia entre nombres y apellidos.
    • SM: Sin Motivo.
    		 2 String
    transactionId Merlin asigna un id de transacción por consulta. 40 String
    nNameComparator Son los datos de comparación obtenidos. – –
    differenceLevelName Indica el nivel de diferencia entre el Nombre y Apellido o denominación ingresado contra la base de contraste. Arroja parámetros entre 0 a 1, siendo 0 (Match Exacto) y 1(Mayor Distancia). Ejemplo: 0.60 4 String
    Mensaje JSON de respuesta
    {
    "status": "ME",
    "statusReason": "",
    "transactionId": "7688d78a-2e31-42f8-b5fd-68be52726d29",
    "nNameComparator": {
        "differenceLevelName": "0.0"
    }
}
    Tema Anterior
    Volver a la Lección
    Próximo Tema