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

> Didit経由でオーストラリアの公的データベースに照会し、市民権証明書を検証。1回$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%\*
* **料金：** 成功した照会1件あたり\$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`はデフォルトの機能ステータスであり、設定した[部分一致/不一致時のアクション](https://docs.didit.me/ja/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`**：識別番号は見つかりましたが、1つ以上の個人情報フィールド（通常は氏名または生年月日）が完全には一致しませんでした。

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

オーストラリア - DVS - 市民権証明書の照会は、Didit が検証元から確定的な結果を受け取った場合にのみ課金されます。

* **呼び出し1件あたりの料金：** \$0.75 USD
* **請求：** 成功した照会1件ごと。登録機関に接続できない場合、必須フィールドが不足している場合、またはリクエストが情報源に到達する前に拒否された場合は課金されません。
* **レイテンシー：** 通常p95 \< 2秒
* **可用性：** Didit 側で四半期あたり99.9%。下流の情報源の可用性は国やデータセットによって異なります。

## 関連情報

* [オーストラリアのデータベース検証の概要](https://docs.didit.me/api-reference/database-validation/australia.md)
* [データベース検証の概要](https://docs.didit.me/ja/core-technology/database-validation/overview.md)
* [結果コード](https://docs.didit.me/ja/core-technology/database-validation/database-validation-outcome-codes.md)


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