Create "people" in Deceval through Apitude

The first step in creating promissory notes (IoUs) is to create the "people" in Deceval. Let's see how we can do this with the REST API.

Create a "person"

Using your favorite programming language and libraries, make the following POST request.


import requests
url = "https://apitude.co/iou/deceval-co/stakeholders/"
payload = {
    "document_type": "CEDULA",
    "city_residence": "BOGOTA",
    "state_residence": "BOGOTA",
    "country_residence": "COLOMBIA",
    "country_nationality": "COLOMBIA",
    "document_expedition_city": "BOGOTA",
    "document_expedition_state": "BOGOTA",
    "document_expedition_country": "COLOMBIA",
    "phone_number": "+573116222222",
    "fax_number": "+573116222222",
    "document_number": "88888881",
    "address": "123 siempre viva",
    "email": "email@gmail.com",
    "name": "Jhon",
    "first_last_name": "Snow",
    "second_last_name": "Stark",
    "birth_date": "1980-08-06",
    "document_expedition_date": "1998-08-15"
}
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 = "{\"document_type\": \"CEDULA\",\"city_residence\": \"BOGOTA\",\"state_residence\": \"BOGOTA\",\"country_residence\": \"COLOMBIA\",\"country_nationality\": \"COLOMBIA\",\"document_expedition_city\": \"BOGOTA\",\"document_expedition_state\": \"BOGOTA\",\"document_expedition_country\": \"COLOMBIA\",\"phone_number\": \"+573116222222\",\"fax_number\": \"+573116222222\",\"document_number\": \"88888881\",\"address\": \"123 siempre viva\",\"email\": \"email@gmail.com\",\"name\": \"Jhon\",\"first_last_name\": \"Snow\",\"second_last_name\": \"Stark\",\"birth_date\": \"1980-08-06\",\"document_expedition_date\": \"1998-08-15\"}";
RequestBody body = RequestBody.create(mediaType, payload);
Request request = new Request.Builder()
  .url("https://apitude.co/iou/deceval-co/stakeholders/")
  .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({
    "document_type": "CEDULA",
    "city_residence": "BOGOTA",
    "state_residence": "BOGOTA",
    "country_residence": "COLOMBIA",
    "country_nationality": "COLOMBIA",
    "document_expedition_city": "BOGOTA",
    "document_expedition_state": "BOGOTA",
    "document_expedition_country": "COLOMBIA",
    "phone_number": "+573116222222",
    "fax_number": "+573116222222",
    "document_number": "88888881",
    "address": "123 siempre viva",
    "email": "email@gmail.com",
    "name": "Jhon",
    "first_last_name": "Snow",
    "second_last_name": "Stark",
    "birth_date": "1980-08-06",
    "document_expedition_date": "1998-08-15"
});
var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};
fetch("https://apitude.co/iou/deceval-co/stakeholders/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));


url := "https://apitude.co/iou/deceval-co/stakeholders/"
method := "POST"
data := "{\"document_type\": \"CEDULA\",\"city_residence\": \"BOGOTA\",\"state_residence\": \"BOGOTA\",\"country_residence\": \"COLOMBIA\",\"country_nationality\": \"COLOMBIA\",\"document_expedition_city\": \"BOGOTA\",\"document_expedition_state\": \"BOGOTA\",\"document_expedition_country\": \"COLOMBIA\",\"phone_number\": \"+573116222222\",\"fax_number\": \"+573116222222\",\"document_number\": \"88888881\",\"address\": \"123 siempre viva\",\"email\": \"email@gmail.com\",\"name\": \"Jhon\",\"first_last_name\": \"Snow\",\"second_last_name\": \"Stark\",\"birth_date\": \"1980-08-06\",\"document_expedition_date\": \"1998-08-15\"}"
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))

Ok, but what does each field in that JSON means?

document_type: This field represents the identity document type (usually the cedula for Colombian citizens) of the person.
city_residence: This field represents the city where the person is living.
state_residence: This field represents the state where the person is living.
country_residence: This field represents the country where the person is living.
country_nationality: This field represents the country where the person was born or nationalized.
document_expedition_city: This field represents the city of issuance of the person's identity document.
document_expedition_state: This field represents the state of issuance of the person's identity document.
document_expedition_country: This field represents the country of issuance of the person's identity document.
phone_number: This field represents the personal phone number of the person. Make sure to include the country code.
fax_number: This field represents the fax number of the person (If the person does not have one input the same value as the phone). Make sure to include the country code.
document_number: This field represents the identity document number (usually the cedula for Colombian citizens) of the person.
address: This field represents the residential address of the person.
email: This field represents the email address of the person.
name: This field represents the given name of the person.
first_last_name: This field represents the first family last name of the person.
second_last_name: This field represents the second family last name of the person.
birth_date: This field represents the birth date of the person in YYYY-MM-DD format.
document_expedition_date: This field represents the issue date of the person national ID in YYYY-MM-DD format.

Obtain all "person"s

Using your favorite programming language and libraries, make the following GET request.


import requests
url = "https://apitude.co/iou/deceval-co/stakeholders/"
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/iou/deceval-co/stakeholders/")
  .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/iou/deceval-co/stakeholders/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));


url := "https://apitude.co/iou/deceval-co/stakeholders/"
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))

The service will return a paginated array of persons you have previously created.

Obtain a particular "person"

Using your favorite programming language and libraries, make the following GET request.


import requests
# The person ID we want to retrieve is "1"
url = "https://apitude.co/iou/deceval-co/stakeholders/1/"
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");
// The person ID we want to retrieve is "1"
Request request = new Request.Builder()
  .url("https://apitude.co/iou/deceval-co/stakeholders/1/")
  .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'
};
// The person ID we want to retrieve is "1"
fetch("https://apitude.co/iou/deceval-co/stakeholders/1/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));


// The person ID we want to retrieve is "1"
url := "https://apitude.co/iou/deceval-co/stakeholders/1/"
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))

The request will return a the person with the ID=1 you selected.

Edit a particular "person"

Using your favorite programming language and libraries, make the following PATCH request Only the fields shown in this example can be edited in a person.


import requests
# The person ID we want to edit is "1"
url = "https://apitude.co/iou/deceval-co/stakeholders/1/"
payload = {
    "city_residence": "BOGOTA",
    "state_residence": "BOGOTA",
    "country_residence": "COLOMBIA",
    "phone_number": "+573116222222",
    "fax_number": "+573116222222",
    "address": "123 siempre viva",
    "email": "email@gmail.com"
}
headers = {
    'x-api-key': 'API-KEY',
    'Content-Type': 'application/json'
}
response = requests.patch(url, headers=headers, data=payload)
print(response.json())


OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
String payload = "{\"city_residence\": \"BOGOTA\",\"state_residence\": \"BOGOTA\",\"country_residence\": \"COLOMBIA\",\"phone_number\": \"+573116222222\",\"fax_number\": \"+573116222222\",\"address\": \"123 siempre viva\",\"email\": \"email@gmail.com\"}";
RequestBody body = RequestBody.create(mediaType, payload);
// The person ID we want to edit is "1"
Request request = new Request.Builder()
  .url("https://apitude.co/iou/deceval-co/stakeholders/1/")
  .method("PATCH", 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({
    "city_residence": "BOGOTA",
    "state_residence": "BOGOTA",
    "country_residence": "COLOMBIA",
    "phone_number": "+573116222222",
    "fax_number": "+573116222222",
    "address": "123 siempre viva",
    "email": "email@gmail.com"
});
var requestOptions = {
  method: 'PATCH',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};
// The person ID we want to edit is "1"
fetch("https://apitude.co/iou/deceval-co/stakeholders/1/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));


// The person ID we want to edit is "1"
url := "https://apitude.co/iou/deceval-co/stakeholders/1/"
method := "PATCH"
data := "{\"city_residence\": \"BOGOTA\",\"state_residence\": \"BOGOTA\",\"country_residence\": \"COLOMBIA\",\"phone_number\": \"+573116222222\",\"fax_number\": \"+573116222222\",\"address\": \"123 siempre viva\",\"email\": \"email@gmail.com\"}"
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))

The request will edit and return the person with the ID=1 you selected.