> ## 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: проверка по официальной базе данных. Оплата за вызов от $0.75, без контрактов и минимальных объёмов.

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

## Покрытие

* **Покрытие:** —
* **Страна:** Южная Африка
* **Идентификатор сервиса:** `zaf_company_registry`
* **Домен данных:** Государственный
* **Категория:** Реестр компаний

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

| Поле | Обязательно | Пример |
| - | -: | - |
| `company_registration_number` | Да | `REG-123456` |
| `company_name` | Нет | `Sample Company LLC` |
| `vendor_data` | Нет | `user-1234` |

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

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

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

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

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

Пример: `ZAF`

**services** `string` *required* (default: zaf\_company\_registry)

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

Пример: `zaf_company_registry`

**company\_registration\_number** `string` *required* (default: REG-123456)

Значение `company_registration_number`, необходимое для этого сервиса проверки по базе данных.

Пример: `REG-123456`

**company\_name** `string`

Значение `company_name`, необходимое для этого сервиса проверки по базе данных.

Пример: `Sample Company LLC`

**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_company_registry" \
  -F "vendor_data=user-1234" \
  -F "company_registration_number=REG-123456"
```

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

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

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

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

## Цены и SLA

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

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