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

# ブラジル死亡確認（CPF）API：リアルタイムでのID照会

> Didit のブラジル死亡確認（CPF）APIで、ブラジルの公的データベースを照会して本人確認ができます。1回$0.20からの従量課金で、契約や最低利用額はありません。

CPFの保有者が死亡者として記録されているかを確認し、保有者の氏名と生年月日をReceita Federalの記録と照合します。Diditはこのサービスを`POST /v3/database-validation/`で提供しているため、送信されたデータを公式の情報源と照合し、正規化された照合結果を受け取ることができます。

## 対象範囲

* **対象範囲：** \~ 100%
* **国：** ブラジル
* **サービスID：** `bra_death_check`
* **データドメイン：** その他
* **カテゴリ：** DeathRecord

## 入力

| フィールド | 必須 | 例 |
| - | -: | - |
| `tax_number` | はい | `12345678909` |
| `first_name` | はい | `John` |
| `last_name` | はい | `Doe` |
| `date_of_birth` | いいえ | `1990-01-01` |
| `vendor_data` | いいえ | `user-1234` |

* **必須入力：** `tax_number`、`first_name`、`last_name`
* **任意入力：** `date_of_birth`、`vendor_data`
* **同意：** 不要
* **ワークフローでの利用：** ワークフローで利用可能
* **カバレッジ：** \~ 100%
* **料金：** 成功したクエリ1件あたり\$0.20

## ボディパラメーター

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

このデータベースサービスのISO 3166-1 alpha-3国コードです。

例：`BRA`

**services** `string` *required* (default: bra\_death\_check)

このサービスIDを含む配列です。サービスを固定することで、リクエストの対象をこのデータベースのみに限定できます。

例：`bra_death_check`

**tax\_number** `string` *required* (default: 12345678909)

税務上の識別番号です。

例：`12345678909`

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

検証する名です。

例：`John`

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

検証する姓です。

例：`Doe`

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

`YYYY-MM-DD`形式の生年月日です。

例：`1990-01-01`

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

社内のユーザーIDなど、この人物に対して一貫して使用するユーザー参照値です。Diditはこれを使用して個別のチェックを同一のエンドユーザーに紐付け、重複検知のノイズを減らします。

例：`user-1234`

## 入力ルールと検証に関する注意

* ブラジルのCPF (ちょうど11桁)
* `tax_number`は数字のみで構成する必要があります。リクエストを送信する前に、スペース、ハイフン、句読点を削除してください。
* `tax_number`はちょうど11文字である必要があります。
* `tax_number`は`\d{3}\.?\d{3}\.?\d{3}-?\d{2}`に一致する必要があります。

## 呼び出し方法

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_death_check" \
  -F "vendor_data=user-1234" \
  -F "tax_number=12345678909" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="BRA",
    services=["bra_death_check"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    tax_number="12345678909",
    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: "BRA",
  services: ["bra_death_check"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  tax_number: "12345678909",
  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: "BRA",
	Services:     didit.Some([]string{"bra_death_check"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	TaxNumber:    didit.String("12345678909"),
	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("BRA")
        .services(List.of("bra_death_check"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .taxNumber("12345678909")
        .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' => 'BRA',
    'services' => ['bra_death_check'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'tax_number' => '12345678909',
    '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: "BRA",
  services: ["bra_death_check"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  tax_number: "12345678909",
  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 = "BRA",
    Services = new string[] { "bra_death_check" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    TaxNumber = "12345678909",
    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": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_death_check",
      "service_name": "Brazil - Death Check (CPF)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "JOHN",
        "full_name": "JOHN DOE",
        "identification_number": "12345678909",
        "is_deceased": false,
        "last_name": "DOE",
        "tax_id_status": "REGULAR"
      },
      "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": "BRA",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "bra_death_check",
      "service_name": "Brazil - Death Check (CPF)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "JOHN",
        "full_name": "JOHN DOE",
        "identification_number": "12345678909",
        "is_deceased": false,
        "last_name": "DOE",
        "tax_id_status": "REGULAR"
      },
      "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": "BRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "bra_death_check",
      "service_name": "Brazil - Death Check (CPF)",
      "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"
      }
    }
  ]
}
```

**`DOCUMENT_NOT_FOUND`**：送信された書類番号に該当する記録がレジストリに存在しません。

```json 200 OK — DOCUMENT_NOT_FOUND theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "BRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "DOCUMENT_NOT_FOUND",
      "service_id": "bra_death_check",
      "service_name": "Brazil - Death Check (CPF)",
      "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"
      }
    }
  ]
}
```

**`DECEASED`**：本人情報は一致しましたが、レジストリではその人物が死亡していることが示されています。

```json 200 OK — DECEASED theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "DECEASED",
      "service_id": "bra_death_check",
      "service_name": "Brazil - Death Check (CPF)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "death_year": 2021,
        "first_name": "JOHN",
        "full_name": "JOHN DOE",
        "identification_number": "12345678909",
        "is_deceased": true,
        "last_name": "DOE",
        "tax_id_status": "TITULAR FALECIDO"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

## 返されるデータ

`source_data`に含まれるフィールドは、レジストリから返される内容によって異なります。`bra_death_check`用に生成された例には、現在、以下の正規化された構造が記載されています。

* `date_of_birth`
* `death_year`
* `first_name`
* `full_name`
* `identification_number`
* `is_deceased`
* `last_name`
* `tax_id_status`

## 料金とSLA

ブラジル - 死亡確認 (CPF)のクエリは、Diditが検証元から確定した結果を受け取った場合にのみ課金されます。

* **1回あたりの料金：** \$0.20 USD。
* **請求：** 成功したクエリ1件あたり。レジストリに接続できない場合、必須フィールドが欠けている場合、またはリクエストが情報源に届く前に拒否された場合は課金されません。
* **レイテンシー：** 通常、p95は2秒未満。
* **可用性：** Didit側で四半期あたり99.9%。下流の情報源の可用性は国やデータセットによって異なります。

## 関連情報

* [ブラジルのデータベース検証の概要](https://docs.didit.me/api-reference/database-validation/brazil.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.