Registraduría Nacional del Estado Civil - Colombia (registraduria-co)

Registraduría Nacional del Estado Civil - Colombia

Para integrar el servicio de Registraduría Nacional del Estado Civil - Colombia en su sistema. Primero, obtenga su API key de Apitude, luego envíe una solicitud POST a Aptitude ... ¡Y eso es todo!.

Get API Access


import requests
url = "https://apitude.co/api/v1.0/requests/registraduria-co/"
payload = {'date_expedition': '1900-01-01', 'document_number': '888888881'}
headers = {
    'x-api-key': 'API-KEY',
    'Content-Type': 'application/json'
}
response = requests.post(url, headers=headers, data=payload)
print(response.json())


OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
String payload = "{\"date_expedition\": \"1900-01-01\", \"document_number\": \"888888881\"}"
RequestBody body = RequestBody.create(mediaType, payload);
Request request = new Request.Builder()
  .url("https://apitude.co/api/v1.0/requests/registraduria-co/")
  .method("POST", body)
  .addHeader("x-api-key", "API-KEY")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();


var myHeaders = new Headers();
myHeaders.append("x-api-key", "API-KEY");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({"date_expedition": "1900-01-01", "document_number": "888888881"});
var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};
fetch("https://apitude.co/api/v1.0/requests/registraduria-co/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));


url := "https://apitude.co/api/v1.0/requests/registraduria-co/"
method := "POST"
data := "{\"date_expedition\": \"1900-01-01\", \"document_number\": \"888888881\"}"
payload := strings.NewReader(data)
client := &http.Client {}
req, err := http.NewRequest(method, url, payload)
if err != nil {
    fmt.Println(err)
}
req.Header.Add("x-api-key", "API-KEY")
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
fmt.Println(string(body))

Esa solicitud POST debe devolver lo siguiente


{
    "message": "Request processed successfully",
    "url": "/api/v1.0/requests/registraduria-co/e0606c19-a32d-410f-b2eb-d57a665677bc/",
    "request_id": "e0606c19-a32d-410f-b2eb-d57a665677bc"
}

Esta respuesta contendrá un ID de solicitud único que debe utilizar enviando un GET de la siguiente manera


import requests
url = "https://apitude.co/api/v1.0/requests/registraduria-co/e0606c19-a32d-410f-b2eb-d57a665677bc/"
headers = {
    'x-api-key': 'API-KEY',
    'Content-Type': 'application/json'
}
response = requests.get(url, headers=headers)
print(response.json())


OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
Request request = new Request.Builder()
  .url("https://apitude.co/api/v1.0/requests/registraduria-co/e0606c19-a32d-410f-b2eb-d57a665677bc/")
  .method("GET")
  .addHeader("x-api-key", "API-KEY")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();


var myHeaders = new Headers();
myHeaders.append("x-api-key", "API-KEY");
myHeaders.append("Content-Type", "application/json");
var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};
fetch("https://apitude.co/api/v1.0/requests/registraduria-co/e0606c19-a32d-410f-b2eb-d57a665677bc/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));


url := "https://apitude.co/api/v1.0/requests/registraduria-co/e0606c19-a32d-410f-b2eb-d57a665677bc/"
method := "GET"
client := &http.Client {}
req, err := http.NewRequest(method, url)
if err != nil {
    fmt.Println(err)
}
req.Header.Add("x-api-key", "API-KEY")
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
fmt.Println(string(body))

¿Cómo se ve la respuesta?


{
   "result": {
      "data": {
         "area": "BOLIVAR",
         "city": "CARTAGENA",
         "name": "JUAN PEREZ",
         "status": "VIGENTE",
         "resolution": "",
         "date_resolution": "2020-05-30"
      },
      "error": "",
      "end_at": "2020-05-30 21:54:06.453355",
      "status": 200,
      "message": "successful",
      "queried_by": "YOUR-USER",
      "service_name": "registraduria-co"
   },
   "message": "Request completed"
}

Ok, pero ¿qué significa cada campo en ese JSON?

Las partes generales:

message:El mensaje es un string generado por Aptitude con un texto informativo sobre la solicitud..
result:El resultado contiene la parte principal de la solicitud..
result.error:El error es un string generado por Aptitude para la solicitud. Si todo funcionó, estará en blanco.
result.message:El mensaje es un string con dos opciones successful o unsuccessful dependiendo de cómo terminó su solicitud.
result.queried_by:El campo queried_by es un string que indica que usuario creo la solicitud.
result.end_at:El campo end_at es un string formatted date que indica en qué momento la solicitud terminó en Apitude.
result.service_name:El campo service_name es un string que retorna el servicio llamado. Para este servicio siempre será registraduria-co.
result.status:El campo estado, es un entero cuyo valor representa si el servicio retorno informacion para la solicitud enviada. Puede tomar alguno de los siguientes valores:
- 200: El servicio devolvió datos con la respuesta para la información que se envió en la solicitud.
- 404: El servicio no devolvió datos con la respuesta para la información que se envió en la solicitud.
- 400: El servicio no se inició porque su entrada no era válida.
- 500: Apitude intentó ejecutar tu solicitud, sin embargo, el servicio que utiliza Apitude para ejecutar su solicitud no funciona. Espera un poco y vuelve a intentarlo, Apitude no te cobrará solicitudes con este código.
Dependiendo del servicio, quieres que devuelva diferente códigos. Por ejemplo, si está pasando al usuario por un proceso de vinculación y desea que este quede en su lista blanca, debe buscar un 404, porque un200 significaría que el usuario está de hecho en la lista. Otros casossin embargo, como crear objetos con el nombre de un usuario, desea que el código sea200, ya que implicará que la creación fue un éxito.

Los datos en la respuesta:

data.area: El área es una cadena con el nombre del estado en el que se emitió el número de identificación nacional del usuario enviado.
data.city: La ciudad es una cadena con el nombre de la ciudad en la que se emitió el número de identificación nacional del usuario enviado.
data.name: El nombre es una cadena con el nombre de la persona que posee el número de identificación nacional enviado.
data.status: El estado es una cadena con el estado del número de identificación nacional del usuario enviado. Los valores posibles son:
- VIGENTE
- SUSPENDIDO : El documento de identidad es válido y funciona
- ROBADO : El documento de identificación se reporta como robado
- VENCIDO : El documento de identificación se reporta como vencido / pendiente de reemplazo
data.resolution: La resolución es una cadena con información adicional del cambio de estado de la identificación nacional (si aplica).
data.date_resolution: La fecha de resolución es una cadena con formato de fecha (YYYY-MM-DD) con la fecha en la que la identificación nacional informó un cambio de estado (si corresponde).

Sobre este servicio

La Registraduría Nacional del Estado Civil de Colombia es una institución descentralizada del Estado de ese país encargada del registro civil nacional, así como de la convocatoria y organización electoral bajo el mandato y supervisión del Consejo Nacional Electoral.

¿A quién puede consultar utilizando este servicio?:

Este servicio (registraduria-co) está disponible para consultar unicamente individuos.

Get API Access

Servicios

Help and support

Pricing

Open Services APIs

Contract Required

Service Pipelines