Identity - Chile
Lets integrate Identity - Chile in your system. First, get your Apitude API key, then send a POST request to Apitude... And that's it!.
That POST request should return the following
{
"message": "Request processed successfully",
"url": "/api/v1.0/requests/identity-cl/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
How does the response looks like?
{
"result": {
"data": {
"age": 58,
"rut": "8888888-1",
"name": "JHON WICK",
"found": true,
"deceased": false,
"addresses": [
{
"city": "SANTIAGO",
"date": "2023-01-04",
"type": "BUSINESS",
"address": "AV. ANDRES BELLO 2425",
"commune": "SANTIAGO CENTRO"
},
{
"city": "NY",
"date": "1999-11-04",
"type": "RESIDENTIAL",
"address": "121 MILL NECK",
"commune": "LONG ISLAND"
}
],
"date_of_birth": "1964-10-12",
"phone_numbers": [
{
"type": "PERSONAL",
"number": "5555555",
"area_code": "02"
},
{
"type": "PERSONAL",
"number": "1946020",
"area_code": "315"
}
],
"email_addresses": [
"jhon.wick@gmail.com",
"the_excommunicado@hotmail.com"
]
},
"error": "",
"end_at": "2023-01-30 21:54:06.453355",
"status": 200,
"message": "successful",
"queried_by": "YOUR-USER",
"service_name": "identity-cl"
},
"message": "Request completed"
}
Ok, but what does each field in that JSON means?
The general parts:
message:
The message is an Apitude generatedstring
with an informational text about the request.result:
The result is contains the main part of the request.result.error:
The error is astring
generated by apitude for the request if everything worked it will be blank.result.message:
The message is astring
with two optionssuccessful
orunsuccessful
depending of how your request finished.result.queried_by:
The queried_by field is astring
that lets you know what user started the request.result.end_at:
The end_at field is astring formatted date
that lets you know at what time the request ended in Apitude.result.service_name:
The service_name field is astring
that echos the service called. For this service it will always beidentity-cl
.result.status:
The status field is ainteger
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 a200
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 be200
, since it will imply the creation was a success.
The data in the response:
-
data.age:
Age is aninteger
with the person's age (number) named in years. -
data.found:
The variable is a boolean-
true
: The RUT code is found with information in the people database. -
false
: The RUT code is not found with information in the people database.
-
-
data.deceased:
The variable is a boolean-
true
: The person who owns the RUT code has died. -
false
: The The person who owns the RUT code is alive.
-
-
data.addresses:
The variable is alist
of objects that represent a previous address of the RUT code. The list can have zero or more elements. The fields of an object are:-
data.addresses[1].city
: The city where the address is reported.
-
-
data .addresses[1].date
: The date inYYYY-MM-DD
format when the address was reported. -
data. addresses[1].type
: The type of address. Possible values are:BUSINESS
for business addresses andRESIDENTIAL
for non-business addresses. -
data.addresses[1].address
: The full address reported. -
data.addresses[1].commune
: The commune where the address is reported. -
data.date_of_birth:
The date of birth is astring
in the formatYYYY-MM-DD
. -
data.phone_numbers:
The variable is alist
of objects representing a previous phone number from the RUT code. The list can have zero or more elements. The fields of an object are:-
data.phone_numbers[1].area_code
: The area code within the reported country. It is astring
-
data.phone_numbers[1].type
: The type of address. Possible values are:BUSINESS
for business addresses andPERSONAL
for non-business addresses. -
data.phone_numbers[1].number
: The reported phone number. It is astring
. Typically, you would concatenate area code phone number to get the full value.
-
-
data.phone_numbers:
The variable is alist
ofstring
objects that represent an email previously reported for the RUT code.
About this service
This service allows you to obtain, through API, the identity validation information that Apitude obtains through our series of affiliated partners. This API receives a Chilean RUT number and returns the information required to validate a user's data, such as addresses, names, emails and phone numbers.
Who can you query using this service?:
This service (identity-cl) is available for you to query individuals only.
Get API Access