> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Проверка директорств физлиц в ЮАР: API

> Проверка директорств физлиц в ЮАР по официальной базе данных через Didit. Оплата за вызов от $1.45, без контрактов и минимальных объёмов.

Возвращает все должности директоров, зарегистрированные в CIPC, которые занимает физическое лицо из ЮАР. Didit предоставляет этот сервис через `POST /v3/database-validation/`, чтобы вы могли сверить переданные данные с авторитетным источником и получить нормализованные результаты сопоставления.

## Покрытие

* **Покрытие:** -
* **Страна:** ЮАР
* **ID сервиса:** `zaf_person_directorships`
* **Домен данных:** Государственные данные
* **Категория:** CompanyRegister

## Входные данные

| Поле | Обязательно | Пример |
| - | -: | - |
| `national_id` | Да | `SAMPLE-NID-12345` |
| `vendor_data` | Нет | `user-1234` |

* **Обязательные поля:** `national_id`
* **Необязательные поля:** `vendor_data`
* **Согласие:** не требуется
* **Доступность в сценарии:** доступно в сценарии
* **Покрытие:** -
* **Цена:** \$1.45 за успешный запрос

## Параметры тела запроса

**issuing\_state** `string` *required* (default: ZAF)

Код страны по ISO 3166-1 alpha-3 для этого сервиса базы данных.

Пример: `ZAF`

**services** `string` *required* (default: zaf\_person\_directorships)

Массив, содержащий ID этого сервиса. Закрепление сервиса ограничивает запрос именно этой базой данных.

Пример: `zaf_person_directorships`

**national\_id** `string` *required* (default: SAMPLE-NID-12345)

Национальный идентификационный номер для этого сервиса.

Пример: `SAMPLE-NID-12345`

**vendor\_data** `string` (default: user-1234)

Ваш стабильный идентификатор этого человека в вашей системе, например внутренний ID пользователя. Didit использует его, чтобы связать отдельные проверки с одним и тем же конечным пользователем и уменьшить количество ложных срабатываний при обнаружении дубликатов.

Пример: `user-1234`

## Правила ввода и примечания по валидации

* Передавайте перечисленные выше поля точно так, как они были получены от пользователя или из документа.
* Didit проверяет обязательные поля до обращения к базе данных. Запросы, отклонённые до поиска в источнике, не тарифицируются.

## Как вызвать

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=ZAF" \
  -F "services=zaf_person_directorships" \
  -F "vendor_data=user-1234" \
  -F "national_id=SAMPLE-NID-12345"
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="ZAF",
    services=["zaf_person_directorships"],
    national_id="SAMPLE-NID-12345",
    vendor_data="user-1234",
)
print(result)
```

```javascript Node.js theme={null}
import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "ZAF",
  services: ["zaf_person_directorships"],
  national_id: "SAMPLE-NID-12345",
  vendor_data: "user-1234",
});
console.log(result);
```

```go Go theme={null}
ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{
	IssuingState: "ZAF",
	Services:     didit.Some([]string{"zaf_person_directorships"}),
	NationalID:   didit.String("SAMPLE-NID-12345"),
	VendorData:   didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.util.List;
import me.didit.Didit;
import me.didit.types.DatabaseValidationValidateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()
        .issuingState("ZAF")
        .services(List.of("zaf_person_directorships"))
        .nationalId("SAMPLE-NID-12345")
        .vendorData("user-1234")
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'ZAF',
    'services' => ['zaf_person_directorships'],
    'national_id' => 'SAMPLE-NID-12345',
    'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
```

```ruby Ruby theme={null}
require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.database_validation.validate(
  issuing_state: "ZAF",
  services: ["zaf_person_directorships"],
  national_id: "SAMPLE-NID-12345",
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "ZAF",
    Services = new string[] { "zaf_person_directorships" },
    NationalId = "SAMPLE-NID-12345",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Каждый успешный вызов возвращает HTTP `200`. Поле **`outcome_code`** показывает, что произошло на самом деле: например, отличает реальное несовпадение биометрии (`BIOMETRIC_NO_MATCH`) от селфи, которое не удалось прочитать (`BIOMETRIC_IMAGE_UNUSABLE`). Показанный `status` является статусом функции по умолчанию; ваши настроенные [действия для частичного совпадения / отсутствия совпадения](https://docs.didit.me/ru/core-technology/database-validation/database-validation-warnings.md) могут его переопределить.

**`MATCH`**: реестр подтвердил личность, и все проверенные поля совпали.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_person_directorships",
      "service_name": "South Africa - Person Directorships Lookup",
      "source_data": {
        "directorships": "sample_value",
        "identification_number": "SAMPLE-ID-12345"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: реестр не вернул совпадений для переданных данных.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_person_directorships",
      "service_name": "South Africa - Person Directorships Lookup",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Возвращаемые данные

Точный набор полей, которые попадают в `source_data`, зависит от того, что возвращает реестр. Сгенерированный пример для `zaf_person_directorships` сейчас описывает такую нормализованную структуру:

* `directorships`
* `identification_number`

## Цены и SLA

Запросы по поиску директорских должностей физических лиц в ЮАР оплачиваются только тогда, когда Didit получает окончательный результат от источника валидации.

* **Цена за вызов:** \$1.45 USD.
* **Биллинг:** за успешный запрос. Плата не взимается, если реестр недоступен, если не заполнены обязательные поля или если запрос отклонён до обращения к источнику.
* **Задержка:** типичное p95 \< 2 с.
* **Доступность:** 99.9% за квартал со стороны Didit; доступность внешнего источника зависит от страны и набора данных.

## Продолжите чтение

* [Обзор проверки по базам данных в ЮАР](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Обзор проверки по базам данных](https://docs.didit.me/ru/core-technology/database-validation/overview.md)
* [Коды результатов](https://docs.didit.me/ru/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.