Base URL: https://demo-api.incodesmile.com — Incode demo environment
Check for a valid Colombian temporary residency ID and return the corresponding values of that person.
Path & query parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
api-version |
header | string | yes |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | ||
emissionDate |
string (dd/mm/yyyy) | mandatory if isForeign is true, otherwise optional | |
fullName |
string | ||
isForeign |
boolean | ||
nameBean |
NameBean | ||
nameBean.fullName |
string | ||
nameBean.fullNameNativeScript |
string | ||
nameBean.firstNameNativeScript |
string | ||
nameBean.paternalLastNameNativeScript |
string | ||
nameBean.maternalLastNameNativeScript |
string | ||
nameBean.machineReadableFullName |
string | Full name from Barcode or MRZ | |
nameBean.firstName |
string | ||
nameBean.middleName |
string | ||
nameBean.givenName |
string | ||
nameBean.givenNameMrz |
string | ||
nameBean.nameSuffix |
string | ||
nameBean.paternalLastName |
string | ||
nameBean.maternalLastName |
string | ||
nameBean.lastNameMrz |
string | ||
nameBean.familyName |
string |
Responses
200
- data: Object with following fields. - estado: String. - fecha_entrega: String. - identidad_venezolana: String. - lugar_entrega: String. - nombre_completo: String. - ppt: String. - tipo_documento: String. - error: String. - findings: String []. - status: Boolean.
400
Bad Request
Response body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
timestamp |
integer (int64) | UTC timestamp in milliseconds | |
status |
integer (int32) | Custom error code or HTTP status code | |
error |
string | HTTP status error | |
message |
string | Custom error message | |
path |
string | Endpoint path | |
details |
object | Custom error details |