ID Check API — Verificar un documento de identidad

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para verificar la identidad de una persona cruzando su dirección, nombre, fecha de nacimiento, correo electrónico y número de teléfono con la base de datos de DQE.

Documentación relacionada de ID Check:

Solicitud GET

Endpoint

GET https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE}&Version=2

Reemplace los valores entre llaves por su propia información.

Parámetro Descripción Obligatorio
SERVER_ADDRESS Dirección del servidor DQE utilizada para procesar la solicitud. Sí
LICENCE_CODE Su código de licencia DQE. Sí
ADDRESS Número y nombre de la calle. Sí
POSTAL_CODE Código postal. Sí
CITY Nombre de la ciudad. Sí
NAME Apellido de la persona a verificar. Sí
FIRST_NAME Nombre de pila de la persona a verificar. Sí
DATE Fecha de nacimiento en formato AAAA-MM-DD. Sí
EMAIL Dirección de correo electrónico a verificar. Sí
PHONE Número de teléfono a verificar. Sí
Version=2 Devuelve información sobre el estado de la licencia. No

Solicitud POST

Endpoint

POST https://{SERVER_ADDRESS}/SEARCH/

Envíe los siguientes parámetros en el cuerpo de la solicitud con formato x-www-form-urlencoded.

Parámetro Descripción Obligatorio
Licence Su código de licencia DQE. Sí
Address Número y nombre de la calle. Sí
PostalCode Código postal. Sí
City Nombre de la ciudad. Sí
LastName Apellido de la persona a verificar. Sí
FirstName Nombre de pila de la persona a verificar. Sí
BirthDate Fecha de nacimiento en formato AAAA-MM-DD. Sí
Email Dirección de correo electrónico a verificar. Sí
Phone Número de teléfono a verificar. Sí
Version Devuelve información sobre el estado de la licencia cuando se establece en 2. No

Respuesta

Respuesta correcta

La respuesta JSON contiene un único objeto DATA1 con las siguientes claves:

Clave Valores posibles Descripción Tipo
Check_FirstName E, S, P, D, ? Resultado de la verificación del nombre de pila. STRING(1)
Check_BirthDate Ver los códigos de fecha de nacimiento a continuación. Resultado de la verificación de la fecha de nacimiento. STRING(3)
Check_Number True, False Indica si el número de calle coincide con la base de datos. STRING(5)
HOUSEHOLDID - Identificador único en la base de datos. STRING(30)
FirstName_Dist - Número de caracteres diferentes entre el nombre de pila enviado y el valor de la base de datos. STRING(2)
LastName_Dist - Número de caracteres diferentes entre el apellido enviado y el valor de la base de datos. STRING(2)
Result FOUND, NOT FOUND Indica si el hogar (household) fue encontrado en función de los datos de dirección, correo electrónico o teléfono. STRING(9)
Check_Email E, D, ? Resultado de la verificación del correo electrónico. STRING(1)
Check_LastName E, S, P, D, ? Resultado de la verificación del apellido. STRING(1)
Check_City E, S, P, N, D, ? Resultado de la verificación de la ciudad. STRING(1)
Check_PostalCode E, N, D, ? Resultado de la verificación del código postal. STRING(1)
Check_Phone E, D, ? Resultado de la verificación del teléfono. STRING(1)
Check_Address E, S, P, N, D, ? Resultado de la verificación de la dirección. STRING(1)

Valores genéricos de los códigos de comparación:

Código Descripción
? El campo no se proporcionó, no está disponible, o el producto contratado no permite esta verificación.
E El valor de la base de datos es estrictamente idéntico al valor proporcionado en la solicitud.
S El valor de la base de datos es cercano al valor proporcionado en la solicitud, con una diferencia de hasta el 10%.
P El valor de la base de datos está bastante alejado del valor proporcionado en la solicitud, con una diferencia de hasta el 25%.
N Para dirección y ciudad: el valor está alejado del valor de la solicitud, con una diferencia de hasta el 35%. Para el código postal: coinciden los 3 primeros dígitos.
D El valor de la base de datos es completamente diferente del valor proporcionado en la solicitud.

Códigos de comparación de la fecha de nacimiento:

Código Descripción
000 El año, el mes y el día son idénticos.
001 El año y el mes son idénticos, pero el día es diferente.
010 El año y el día son idénticos, pero el mes es diferente.
100 El mes y el día son idénticos, pero el año es diferente.
011 El año es idéntico, pero el mes y el día son diferentes.
101 El mes es idéntico, pero el año y el día son diferentes.
110 El día es idéntico, pero el año y el mes son diferentes.
111 El año, el mes y el día son diferentes.
--- No hay ninguna fecha disponible en la base de datos.

Ejemplo:

{
  "DATA1": {
    "Check_FirstName": "E",
    "Check_BirthDate": "000",
    "Check_Number": "True",
    "HOUSEHOLDID": "3678263863104901575",
    "FirstName_Dist": "0",
    "LastName_Dist": "0",
    "Result": "FOUND",
    "Check_Email": "D",
    "Check_LastName": "E",
    "Check_City": "E",
    "Check_Address": "E",
    "Check_PostalCode": "E",
    "Check_Phone": "D"
  }
}

Respuesta de error

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Address",
  "error": "bad request"
}
Caso de error Estado HTTP Mensaje Ejemplo de detalle
Licencia ausente, vacía o incorrecta 401 Your licence is not allowed to cover this functionality Código de licencia vacío o incorrecto.
Address ausente o vacío 400 Missing parameters Address
PostalCode ausente o vacío 400 Missing parameters PostalCode
LastName ausente o vacío 400 Missing parameters LastName
Error tipográfico en un parámetro 400 Missing parameters Nombre del parámetro esperado que falta.

Documentación Swagger

Ver también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0