> ## 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.28 за вызов, без контрактов и минимумов.

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

## Покрытие

* **Покрытие:** —
* **Страна:** Южная Африка
* **ID сервиса:** `zaf_refugee`
* **Область данных:** Идентификация
* **Категория:** Государственные органы

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

| Поле | Обязательное | Пример |
| - | -: | - |
| `refugee_file_number` | Да | `RF123456` |
| `phone_number` | Нет | `+15550101000` |
| `email` | Нет | `john.doe@example.com` |
| `vendor_data` | Нет | `user-1234` |

* **Обязательные входные данные:** `refugee_file_number`
* **Необязательные входные данные:** `phone_number`, `email`, `vendor_data`
* **Согласие:** Не требуется
* **Доступность в сценарии:** Доступна в сценарии с сопоставлением полей
* **Покрытие:** —
* **Цена:** \$1.28 за успешный запрос

В сценарии `refugee_file_number` не печатается в документе, удостоверяющем личность, поэтому ни один шаг не формирует его сам по себе. Получите его из ответа на вопрос анкеты, из поля извлечения Document AI или из значения, которое вы передаёте при создании сессии, и сопоставьте его на шаге «Проверка по базам данных». Пока поле не сопоставлено, редактор сценариев показывает этот сервис неактивным и называет недостающий входной параметр. Во время выполнения отсутствие параметра означает, что проверка пропускается до любого запроса, поэтому с вас не берётся плата за базу данных, которую не удалось запросить.

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

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

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

Пример: `ZAF`

**services** `string` *required* (default: zaf\_refugee)

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

Пример: `zaf_refugee`

**refugee\_file\_number** `string` *required* (default: RF123456)

Значение `refugee_file_number`, обязательное для этого сервиса базы данных.

Пример: `RF123456`

**phone\_number** `string`

Значение `phone_number`, обязательное для этого сервиса базы данных.

Пример: `+15550101000`

**email** `string`

Адрес электронной почты.

Пример: `john.doe@example.com`

**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_refugee" \
  -F "vendor_data=user-1234" \
  -F "refugee_file_number=RF123456"
```

Каждый успешный вызов возвращает 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_refugee",
      "service_name": "South Africa - Refugee File Verification",
      "source_data": {},
      "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_refugee",
      "service_name": "South Africa - Refugee File Verification",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

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

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

* Зависит от ответа реестра.

## Цены и SLA

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

* **Цена за вызов:** \$1.28 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.