> ## 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.

# Südafrika: Personen-Directorships-Abfrage API

> Autoritative Datenbankabfrage für Südafrika über Didit: Personen-Directorships ab $1.45 pro Abfrage, ohne Verträge oder Mindestabnahme.

Gibt alle bei CIPC registrierten Direktorenämter einer natürlichen Person aus Südafrika zurück. Didit stellt diesen Dienst über `POST /v3/database-validation/` bereit, damit Sie die übermittelten Daten mit der maßgeblichen Quelle abgleichen und normalisierte Übereinstimmungsergebnisse erhalten können.

## Abdeckung

* **Abdeckung:** —
* **Land:** Südafrika
* **Service-ID:** `zaf_person_directorships`
* **Datenbereich:** Behörden
* **Kategorie:** CompanyRegister

## Eingaben

| Feld | Pflichtfeld | Beispiel |
| - | -: | - |
| `national_id` | Ja | `SAMPLE-NID-12345` |
| `vendor_data` | Nein | `user-1234` |

* **Pflichteingaben:** `national_id`
* **Optionale Eingaben:** `vendor_data`
* **Einwilligung:** Nicht erforderlich
* **Verfügbarkeit im Workflow:** Im Workflow verfügbar
* **Abdeckung:** —
* **Preis:** \$1.45 pro erfolgreiche Abfrage

## Body-Parameter

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

ISO-3166-1-Alpha-3-Ländercode für diesen Datenbankdienst.

Beispiel: `ZAF`

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

Array mit dieser Dienst-ID. Durch das Festlegen des Dienstes bleibt die Anfrage auf genau diese Datenbank beschränkt.

Beispiel: `zaf_person_directorships`

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

Nationale Ausweisnummer für diesen Dienst.

Beispiel: `SAMPLE-NID-12345`

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

Ihre stabile Benutzerreferenz für diese Person, etwa Ihre interne Benutzer-ID. Didit verwendet sie, um eigenständige Prüfungen demselben Endbenutzer zuzuordnen und Störungen durch die Duplikaterkennung zu verringern.

Beispiel: `user-1234`

## Eingaberegeln und Validierungshinweise

* Senden Sie die oben aufgeführten Felder genau so, wie sie vom Benutzer oder aus dem Dokument erfasst wurden.
* Didit prüft Pflichtfelder, bevor die Datenbank aufgerufen wird. Anfragen, die vor der Abfrage der Quelle abgelehnt werden, werden nicht berechnet.

## So rufen Sie es auf

```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));
```

Jeder erfolgreiche Aufruf gibt HTTP `200` zurück. Das Feld **`outcome_code`** zeigt an, was tatsächlich passiert ist, etwa ob eine echte biometrische Nichtübereinstimmung (`BIOMETRIC_NO_MATCH`) vorliegt oder ein Selfie nicht lesbar war (`BIOMETRIC_IMAGE_UNUSABLE`). Der angezeigte `status` ist der Standardstatus der Funktion. Ihre konfigurierten [Aktionen für Teilübereinstimmung und Keine Übereinstimmung](https://docs.didit.me/de/core-technology/database-validation/database-validation-warnings.md) können ihn überschreiben.

**`MATCH`**: Das Register hat die Identität bestätigt, und alle geprüften Felder stimmten überein.

```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`**: Das Register hat für die übermittelten Daten keine Übereinstimmung gefunden.

```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"
      }
    }
  ]
}
```

## Zurückgegebene Daten

Welche Felder genau in `source_data` ausgegeben werden, hängt davon ab, was das Register zurückgibt. Das generierte Beispiel für `zaf_person_directorships` dokumentiert derzeit diese normalisierte Struktur:

* `directorships`
* `identification_number`

## Preise und SLAs

Abfragen der Suche nach Direktorenämtern in Südafrika werden nur berechnet, wenn Didit ein eindeutiges Ergebnis von der Validierungsquelle erhält.

* **Preis pro Aufruf:** \$1.45 USD.
* **Abrechnung:** pro erfolgreiche Abfrage. Sie werden nicht berechnet, wenn das Register nicht erreichbar ist, wenn Pflichtfelder fehlen oder wenn die Anfrage abgelehnt wird, bevor sie die Quelle erreicht.
* **Latenz:** typischer p95-Wert unter 2 s.
* **Verfügbarkeit:** 99.9% pro Quartal auf Seiten von Didit. Die Verfügbarkeit der nachgelagerten Quelle variiert je nach Land und Datensatz.

## Weiterlesen

* [Übersicht zur Datenbankvalidierung für Südafrika](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Übersicht über die Datenbankvalidierung](https://docs.didit.me/de/core-technology/database-validation/overview.md)
* [Ergebniscodes](https://docs.didit.me/de/core-technology/database-validation/database-validation-outcome-codes.md)


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