Consulta de registros civiles

/civilRegistry

Esta API permite consultar información contra registros civiles, se admiten los siguientes registros:

• RENIEC (Perú 🇵🇪)

• DHA (Sudáfrica 🇿🇦)

• Melissa EID (Global 🌍)

• Registro Civil de Chile (Chile 🇨🇱)

---

RENIEC

Consulta por número de documento La siguiente solicitud permite obtener los datos asociados a un número de documento (CUI):

bash

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/reniec/documents/{DOCUMENT_NUMBER}' \
--header 'x-api-key: {API_KEY}'

Parámetros de la solicitud:

Campo	Descripción
DOCUMENT_NUMBER	Número de documento de 8 dígitos (CUI)

Ejemplo de respuesta:

200 OK

Content-Type: application/json

json

{
    "addrContinent": "XXXXXXX                                           ",
    "addrCountry": "XXXX                                              ",
    "apellidoCasada": "                                        ",
    "apellidoMaterno": "XXXXXXX                                 ",
    "apellidoPaterno": "XXXXXXX                                 ",
    "blkDireccion": "   ",
    "civilStatus": "0",
    "departamentoNacimiento": "XXXXXXXXXXX                             ",
    "direccion": "XXXXXXXXXXXXXXXXXXX                                         ",
    "distDomicilio": "XXXXXXXX                                ",
    "distritoNacimiento": "XXXXXXXX                                ",
    "dni": "00000000",
    "dptoDomicilio": "XXXXXXXXXXX                             ",
    "dver": "0",
    "etapaDireccion": "    ",
    "fechaCaducidad": "00000000",
    "fechaExpedicion": "00000000",
    "fechaInscripcion": "00000000",
    "fechaNacimiento": "00000000",
    "intDireccion": "000     ",
    "lotDireccion": "    ",
    "mznDireccion": "    ",
    "nombres": "XXXXXXXXXXXX                                                ",
    "numDireccion": "000 ",
    "paisNacimiento": "XXXX                                              ",
    "picture": "",
    "preBlockChalet": "  ",
    "preDireccion": "00",
    "preDptoPisoInterior": "00",
    "preUrb": "00",
    "provDomicilio": "XXXXXXXX                                ",
    "provinciaNacimiento": "XXXXXXXX                                ",
    "sexo": "0",
    "sip_authenticator": null,
    "sip_host": null,
    "sip_port": null,
    "ubigeoContinent": "00",
    "ubigeoContinentNacimiento": "00",
    "ubigeoCountry": "00",
    "ubigeoCountryNacimiento": "00",
    "urbDireccion": "XXXXXXXXXXXXX                 "
}

---

DHA

Crear Cliente Necesitará crear un cliente antes de realizar cualquiera de las verificaciones y validaciones del consumidor.

La siguiente solicitud le permite crear un nuevo cliente:

bash

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/dha/customers' \
--data-raw '{
    "id_type": "id_number",
    "id_number": "9999999999999",
    "client_reference": "clientnumber1",
    "email": "[email protected]",
    "first_name": "Walter",
    "middle_name": "Hartwell",
    "last_name": "White",
    "popi": true,
    "terms_and_conditions": true,
    "country": null
}' \
--header 'x-api-key: {API_KEY}'

Parámetros de la solicitud:

Campo	Descripción
id_type	string: "id_number" O "passport"
id_number	string: Número de identificación sudafricano de 13 dígitos
first_name	string: El nombre del cliente según su documento de identidad.
middle_name	string: El segundo nombre del cliente según su documento de identidad.
last_name	string: El apellido del cliente según su documento de identidad.
email	string: La dirección de correo electrónico del cliente. Debe tener el formato [email protected]
client_reference	string: Esta es una referencia que puede usar para identificar y buscar al cliente en su sistema. Cada cliente necesita un client_reference único.
country	string: La nacionalidad del cliente.
popi	boolean: Se utiliza para almacenar si el cliente le ha dado su Consentimiento bajo la Ley de Protección de la Información Personal (POPI) para continuar con la recopilación de sus datos y realizar verificaciones adicionales.
terms_and_conditions	string: Se utiliza para almacenar si el cliente ha aceptado los Términos y Condiciones de la Aplicación y las Verificaciones que está realizando.

Ejemplo de respuesta:

200 OK

Content-Type: application/json

json

{
   "id": "16cd33d2-cf0a-66ad-8150-cb39e9b9ff27",
    "client_reference": "clientnumber1",
    "popi": null,
    "terms_and_conditions": null,
    "email": "[email protected]",
    "id_number": "9999999999999",
    "first_name": "Walter",
    "middle_name": "Hartwell",
    "last_name": "White",
    "full_name": "Walter Hartwell White",
    "id_type": "id_number",
    "country": null,
    "initials": "WHW",
}

Validar Cliente La siguiente solicitud le permite obtener los datos asociados a un número de identificación:

Tenga en cuenta que realizaremos la Verificación en el Número de Identificación que se proporcionó en el endpoint POST Crear Nuevo Cliente.

bash

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/dha/validation/{ID_NUMBER}' \
--header 'x-api-key: {API_KEY}'

Parámetros de la solicitud:

Campo	Descripción
DOCUMENT_NUMBER	Número de identificación de 13 dígitos

Ejemplo de respuesta:

200 OK

Content-Type: application/json

json

{
    "id": "d56c6eb9-0caf-4c36-ae3d-6be8841a10d4",
    "idNumber": "{{idNumber}}",
    "firstNames": "{{firstName}}",
    "surname": "{{lastName}}",
    "gender": "Female",
    "dateOfBirth": "1992-08-01T00:00:00",
    "status": "Active",
    "datePerformed": "2024-03-01T14:46:06.4871561+02:00",
    "birthPlaceCountryCode": "",
    "deadIndicator": false,
    "dateOfDeath": "",
    "maritalStatus": "",
    "dateOfMarriage": "",
    "idIssueDate": "20160831",
    "idSequenceNumber": "1",
    "onHANIS": true,
    "onNPR": true,
    "smartCardIssued": true,
    "idNumberBlocked": false,
    "photo": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDABA.....",
    "dataSource": "DHA SAFPS",
    "hasPhoto": true
}

---

Melissa EID

bash

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/melissaeid' \
--data-raw '{
  "TransmissionReference":"",
  "Actions":"Check,Verify",
  "AddressOptions":"",
  "EmailOptions":"",
  "PhoneOptions":"",
  "NameOptions":"NameHint:DefinitelyFull",
  "Options":"",
  ...
}' \
--header 'x-api-key: {API_KEY}'

Información Consulte la lista completa de parámetros y sus opciones en la documentación oficial de Melissa: https://www.melissa.com/quickstart-guides/personator-identity>

Ejemplo de respuesta:

200 OK

Content-Type: application/json

json

{
  "Address": {
    "AddressKey": "{{addressKey}}",
    "AddressLine1": "{{addressLine1}}",
    "AddressLine2": "{{addressLine2}}",
    "AddressLine3": "{{addressLine3}}",
    ...
  },
  "Email": {
    "BreachCount": "",
    "DateChecked": "8/24/2023 9:51:25 PM",
    "DeliverabilityConfidenceScore": "55",
    "DomainAddress1": "",
    ...
  },
  "Identity": {
    "AccountNumber": {
      "Validated": ""
    },
    "BusinessInformation": {
      "ID": "",
      "Name": "",
      "RegistrationDate": "",
      "Status": "",
      "Type": ""
    },
    "Confidence": "High",
    "Datasources": [
      {
        "DatasourceName": "Credit-1",
        "Messages": [
          {
            "Description": "First/given/forename matched",
            "ResultCode": "KV03"
          },
          {
            "Description": "Full match was made on First Initial",
            "ResultCode": "KV31"
          },
          {
            "Description": "Last/surname name matched",
            "ResultCode": "KV04"
          },
          ...
        ],
        "Results": "KV03,KV31,KV04,KV01,KV10,KV11,KV12,KV13,KV14"
      }
    ],
    "DateOfBirth": "{{dateOfBirth}}",
    "NationalID": "{{nationalId}",
    "Results": "KV03,KV31,KV04,KV01,KV10,KV11,KV12,KV13,KV14",
    "WatchlistPersons": "",
    "Watchlists": {
      "Articles": [],
      "Hit": "",
      "ReportLink": "",
      "Sources": []
    }
  },
  "Name": {
    "Company": "",
    "Gender": "",
    "Gender2": "",
    "NameFirst": "{{nameFirst}}",
    ...
  },
  "Phone": {
    "AdministrativeArea": "",
    "CallerID": "",
    "Carrier": "EE Limited (Orange)",
    "CountryAbbreviation": "GB",
    ...
  },
  "Results": "",
  "TransactionID": "{{transactionId}",
  "TransmissionReference": "",
  "Version": "7.2.0.1214"
}

Información Consulte la respuesta completa y sus diferentes campos en la documentación oficial de Melissa: https://www.melissa.com/quickstart-guides/personator-identity

---

Validación COW del Registro Civil de Chile

Este servicio permite la verificación de la validez y el estado de las cédulas de identidad chilenas mediante la integración con el sistema COW (Certificado de Validez) del Registro Civil de Chile.

bash

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/vigencia-cow' --header 'x-api-key: {API_KEY}' --data-raw '{
  "RUN": "12345678-9",
  "credentialNumber": "000000000"
}'

Parámetros de la solicitud:

Campo	Descripción
RUN	El número de identificación chileno (RUT) del usuario, incluyendo el dígito verificador.
credentialNumber	Un número de credencial único asociado al documento de identidad.

Ejemplo de respuesta:

200 OK

Content-Type: application/json

json

{
  "responseData": {
    "idTransaction": "03a10a56-cf9f-4248-bd60-5ce992562930",
    "transactionDate": "2024-12-13",
    "statusTransaction": "000",
    "errorDescription": "ACK"
  },
  "identity": [
    {
      "status": "NO BLOQUEADO",
      "run": "12345678-9",
      "credentialProfileId": "CEDULA",
      "credentialNumber": "000000000",
      "expiryDate": "2029-06-22",
      "validityStatus": "VIGENTE"
    }
  ]
}

Campos de respuesta

Campo	Tipo	Descripción	Requerido
responseData	Objeto (ResponseData)	Contiene los datos de la transacción.	Sí
identity	Lista (IdentityCOW)	Contiene los detalles de la identidad.	Sí

ResponseData

Campo	Tipo	Descripción	Requerido
idTransaction	string	Identificador único de la transacción.	Sí
transactionDate	string	Fecha de la transacción en formato AAAA-MM-DD.	Sí
statusTransaction	string	Estado de la transacción: - 000: ACK (Reconocido) - 201: Error técnico - 206: Formato inválido - 301: Datos inexistentes - 304: Mala calidad - 306: No se proporcionó huella dactilar	Sí
errorDescription	string	Descripción del estado de la transacción: - ACK: Reconocido - Technical error: Ocurrió un error durante el procesamiento - Invalid format: El formato proporcionado es incorrecto - Non-existent data: No se encontraron datos - Poor quality: Los datos proporcionados son de calidad insuficiente - No fingerprint provided: Faltaron datos de huella dactilar	Sí

Identity

Campo	Tipo	Descripción	Requerido
RUN	string	Número de identificación nacional chileno (RUT).	Sí
credentialProfileId	string	Tipo de credencial. Valores permitidos: CEDULA, CEDULA_EXT, PASAPORTE, DOC_VIAJE, TITULO_VIAJE, SALVO_CONDUCTO.	Sí
credentialNumber	string	Número de documento asociado a la credencial.	Sí
expiryDate	string	Fecha de vencimiento de la credencial.	Sí
validityStatus	string	Estado de validez de la credencial. Valores permitidos: VIGENTE, NO_VIGENTE.	Sí
status	string	Estado detallado de la credencial. Valores permitidos: NO BLOQUEADO, CREACIÓN/RENOVACIÓN, TEMPORAL, TEMPORAL PERMANENTE, DEFINITIVO.	Sí