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

# Верификация гражданства Австралии — DVS API

> Проверка сертификата гражданства Австралии через DVS в Didit: данные из официальной базы. От $0.75 за вызов, без контрактов и минимумов.

Проверяет входные данные по Document Verification Service (DVS). Didit предоставляет этот сервис через `POST /v3/database-validation/`, чтобы вы могли сверить отправленные данные с авторитетным источником и получить нормализованные результаты сопоставления.

## Покрытие

* **Покрытие:** 100%\*
* **Страна:** Австралия
* **ID сервиса:** `aus_citizenship_certificate`
* **Домен данных:** Идентификация
* **Категория:** Гражданство

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

| Поле | Обязательное | Пример |
| - | -: | - |
| `first_name` | Да | `John` |
| `last_name` | Да | `Doe` |
| `date_of_birth` | Да | `1990-01-01` |
| `citizenship_certificate_number` | Да | `SAMPLE-CERT-12345` |
| `middle_name` | Нет | `Demo` |
| `vendor_data` | Нет | `user-1234` |

* **Обязательные входные данные:** `first_name`, `last_name`, `date_of_birth`, `citizenship_certificate_number`
* **Необязательные входные данные:** `middle_name`, `vendor_data`
* **Согласие:** требуется
* **Доступность в сценарии:** доступно в сценарии с сопоставлением полей
* **Покрытие:** 100%\*
* **Цена:** \$0.75 за успешный запрос

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

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

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

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

Пример: `AUS`

**services** `string` *required* (default: aus\_citizenship\_certificate)

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

Пример: `aus_citizenship_certificate`

**consent** `boolean` *required* (default: true)

Явное согласие конечного пользователя на использование этого сервиса.

Пример: `true`

**first\_name** `string` *required* (default: John)

Имя, которое нужно проверить.

Пример: `John`

**last\_name** `string` *required* (default: Doe)

Фамилия, которую нужно проверить.

Пример: `Doe`

**date\_of\_birth** `string` *required* (default: 1990-01-01)

Дата рождения в формате `YYYY-MM-DD`.

Пример: `1990-01-01`

**citizenship\_certificate\_number** `string` *required* (default: SAMPLE-CERT-12345)

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

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

**middle\_name** `string`

Второе имя, если оно указано.

Пример: `Demo`

**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=AUS" \
  -F "services=aus_citizenship_certificate" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F "citizenship_certificate_number=SAMPLE-CERT-12345"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="AUS",
    services=["aus_citizenship_certificate"],
    consent=True,
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    citizenship_certificate_number="SAMPLE-CERT-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: "AUS",
  services: ["aus_citizenship_certificate"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  citizenship_certificate_number: "SAMPLE-CERT-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:                 "AUS",
	Services:                     didit.Some([]string{"aus_citizenship_certificate"}),
	Consent:                      didit.Bool(true),
	FirstName:                    didit.String("John"),
	LastName:                     didit.String("Doe"),
	DateOfBirth:                  didit.String("1990-01-01"),
	CitizenshipCertificateNumber: didit.String("SAMPLE-CERT-12345"),
	VendorData:                   didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.time.LocalDate;
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("AUS")
        .services(List.of("aus_citizenship_certificate"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .citizenshipCertificateNumber("SAMPLE-CERT-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' => 'AUS',
    'services' => ['aus_citizenship_certificate'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'citizenship_certificate_number' => 'SAMPLE-CERT-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: "AUS",
  services: ["aus_citizenship_certificate"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  citizenship_certificate_number: "SAMPLE-CERT-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 = "AUS",
    Services = new string[] { "aus_citizenship_certificate" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    CitizenshipCertificateNumber = "SAMPLE-CERT-12345",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Каждый успешный вызов возвращает HTTP `200`. Поле **`outcome_code`** показывает, что произошло на самом деле: например, оно отличает реальное несовпадение биометрии (`BIOMETRIC_NO_MATCH`) от селфи, которое не удалось прочитать (`BIOMETRIC_IMAGE_UNUSABLE`). Показанный `status` — это статус функции по умолчанию; ваши настроенные [действия Partial Match / No Match](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": "AUS",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "aus_citizenship_certificate",
      "service_name": "Australia - DVS – Citizenship Certificate",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "middle_name": "Demo"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: идентификационный номер найден, но одно или несколько личных полей (обычно имя или дата рождения) совпали не полностью.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "AUS",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "aus_citizenship_certificate",
      "service_name": "Australia - DVS – Citizenship Certificate",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "middle_name": "Demo"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

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

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "AUS",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "aus_citizenship_certificate",
      "service_name": "Australia - DVS – Citizenship Certificate",
      "source_data": {
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "date_of_birth": "no_match",
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

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

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

* `date_of_birth`
* `first_name`
* `identification_number`
* `last_name`
* `middle_name`

## Цены и SLA

Запросы Australia - DVS – Citizenship Certificate тарифицируются только тогда, когда Didit получает окончательный результат от источника проверки.

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

## Что почитать дальше

* [Обзор проверки по базам данных для Австралии](https://docs.didit.me/api-reference/database-validation/australia.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.