---
title: "Colombia - Temporary Residency / PPT Validation"
url: "https://developer.incode.com/api-reference/api-validate-registraduria-ppt/"
section: "api-reference"
group: "API validations"
version: "v1.1"
status: "live"
endpoint: "POST /api/validate/registraduria-ppt"
---
# Colombia - Temporary Residency / PPT Validation

`POST /api/validate/registraduria-ppt`

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 |

## Code samples

Generated from this endpoint's method, path, and the conventional Incode headers. The base URL is the Incode demo environment; replace `<YOUR_API_KEY>` with a key for your region.

### cURL

```bash
curl -X POST https://demo-api.incodesmile.com/api/validate/registraduria-ppt \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "api-version: 1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "",
    "emissionDate": "",
    "fullName": "",
    "isForeign": false,
    "nameBean": "",
    "nameBean.fullName": "",
    "nameBean.fullNameNativeScript": "",
    "nameBean.firstNameNativeScript": "",
    "nameBean.paternalLastNameNativeScript": "",
    "nameBean.maternalLastNameNativeScript": "",
    "nameBean.machineReadableFullName": "",
    "nameBean.firstName": "",
    "nameBean.middleName": "",
    "nameBean.givenName": "",
    "nameBean.givenNameMrz": "",
    "nameBean.nameSuffix": "",
    "nameBean.paternalLastName": "",
    "nameBean.maternalLastName": "",
    "nameBean.lastNameMrz": "",
    "nameBean.familyName": ""
  }'
```

### Node

```js
const res = await fetch("https://demo-api.incodesmile.com/api/validate/registraduria-ppt", {
  method: "POST",
  headers: {
      "x-api-key": "<YOUR_API_KEY>",
      "api-version": "1.0",
      "Content-Type": "application/json",
  },
    body: JSON.stringify({
      "id": "",
      "emissionDate": "",
      "fullName": "",
      "isForeign": false,
      "nameBean": "",
      "nameBean.fullName": "",
      "nameBean.fullNameNativeScript": "",
      "nameBean.firstNameNativeScript": "",
      "nameBean.paternalLastNameNativeScript": "",
      "nameBean.maternalLastNameNativeScript": "",
      "nameBean.machineReadableFullName": "",
      "nameBean.firstName": "",
      "nameBean.middleName": "",
      "nameBean.givenName": "",
      "nameBean.givenNameMrz": "",
      "nameBean.nameSuffix": "",
      "nameBean.paternalLastName": "",
      "nameBean.maternalLastName": "",
      "nameBean.lastNameMrz": "",
      "nameBean.familyName": ""
    }),
});
const data = await res.json();
```

### Python

```python
import requests

headers = {
    "x-api-key": "<YOUR_API_KEY>",
    "api-version": "1.0",
    "Content-Type": "application/json",
}
res = requests.post("https://demo-api.incodesmile.com/api/validate/registraduria-ppt", headers=headers, json={
  "id": "",
  "emissionDate": "",
  "fullName": "",
  "isForeign": False,
  "nameBean": "",
  "nameBean.fullName": "",
  "nameBean.fullNameNativeScript": "",
  "nameBean.firstNameNativeScript": "",
  "nameBean.paternalLastNameNativeScript": "",
  "nameBean.maternalLastNameNativeScript": "",
  "nameBean.machineReadableFullName": "",
  "nameBean.firstName": "",
  "nameBean.middleName": "",
  "nameBean.givenName": "",
  "nameBean.givenNameMrz": "",
  "nameBean.nameSuffix": "",
  "nameBean.paternalLastName": "",
  "nameBean.maternalLastName": "",
  "nameBean.lastNameMrz": "",
  "nameBean.familyName": ""
})
data = res.json()
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://demo-api.incodesmile.com/api/validate/registraduria-ppt"))
    .header("x-api-key", "<YOUR_API_KEY>")
    .header("api-version", "1.0")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"id\": \"\",\n  \"emissionDate\": \"\",\n  \"fullName\": \"\",\n  \"isForeign\": false,\n  \"nameBean\": \"\",\n  \"nameBean.fullName\": \"\",\n  \"nameBean.fullNameNativeScript\": \"\",\n  \"nameBean.firstNameNativeScript\": \"\",\n  \"nameBean.paternalLastNameNativeScript\": \"\",\n  \"nameBean.maternalLastNameNativeScript\": \"\",\n  \"nameBean.machineReadableFullName\": \"\",\n  \"nameBean.firstName\": \"\",\n  \"nameBean.middleName\": \"\",\n  \"nameBean.givenName\": \"\",\n  \"nameBean.givenNameMrz\": \"\",\n  \"nameBean.nameSuffix\": \"\",\n  \"nameBean.paternalLastName\": \"\",\n  \"nameBean.maternalLastName\": \"\",\n  \"nameBean.lastNameMrz\": \"\",\n  \"nameBean.familyName\": \"\"\n}"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient()
    .send(req, HttpResponse.BodyHandlers.ofString());
```

### Example response

```json
{
  "success": true,
  "status": "OK"
}
```