National Registry of Civil Status - Colombia

Lets integrate National Registry of Civil Status - Colombia in your system. First, get your Apitude API key, then send a POST request to Apitude... And that's it!.

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))

That POST request should return the following


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

This response will contains a unique request ID that you should poll using a GET as follows


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))

How does the response looks like?


{
   "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, but what does each field in that JSON means?

The general parts:

message:The message is an Apitude generated string with an informational text about the request.
result:The result is contains the main part of the request.
result.error:The error is a string generated by apitude for the request if everything worked it will be blank.
result.message:The message is a string with two options successful or unsuccessful depending of how your request finished.
result.queried_by:The queried_by field is a string that lets you know what user started the request.
result.end_at:The end_at field is a string formatted date that lets you know at what time the request ended in Apitude.
result.service_name:The service_name field is a string that echos the service called. For this service it will always be registraduria-co.
result.status:The status field is a integer that represents whether the service returned data from the input sent in the request. It could be one of the following values:
- 200: The service returned response data for the payload that was sent in the creation of the request.
- 404: The service did not returned data for the payload that was sent in the creation of the request.
- 400: The service did not started because your input was invalid.
- 500: Apitude tried to execute your request, however the service Apitude uses to execute your request was down. Please wait some time and try again, Apitude will not charged you for requests with this code.
Depending on the service, you want it to return different codes. For example, if you are checking the user against a security list to whitelist the user you should look for a 404, because a 200 would mean the user is in fact in the list. Other cases however, like creating objects in the name of a user you want the code to be 200, since it will imply the creation was a success.

The data in the response:

data.area:The area is a string with the name of the state in which the national ID number of the submitted user was issued.
data.city:The city is a string with the name of the city in which the national ID number of the submitted user was issued.
data.name:The name is a string with the name of the person who owns the national ID number submitted.
data.status:The status is a string with the state of the national ID number of the submitted user. The possible values are:
- VIGENTE
- SUSPENDIDO: The ID document is valid and working
- ROBADO: The ID document is reported as stolen
- VENCIDO: The ID document is reported as expired/pending replacement
data.resolution:The resolution is a string with additional information of the change of state of the national ID (if applicable).
data.date_resolution:The date_resolution is a string formatted date (YYYY-MM-DD) with the date in which the national ID reported a changed state (if applicable).

About this service

The National Civil Registry is the government agency of Colombia charged with collecting and storing the vital statistics and identifying information of all citizens, and to regulate the distribution and organization of identity documentation for each citizen for legal purposes.

Who can you query using this service?:

This service (registraduria-co) is available for you to query individuals only.

Get API Access

Services

Help and support

Pricing

Open Services APIs

Contract Required

Service Pipelines

Biometric Validation