> ## 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のAPIで、ブラジルのCPFステータスを公式データベースと照合して確認できます。1回$0.20からの従量課金で、契約や最低利用額はありません。

SERPROを介してReceita Federal(ブラジル連邦歳入庁)から、CPFのステータス(正常、停止、取消)、氏名、ソーシャルネーム、登録日を取得します。照会はCPFと生年月日をキーとして行われます。Didit はこのサービスを`POST /v3/database-validation/`で提供しており、送信されたデータを公式の情報源と照合し、正規化された照合結果を受け取ることができます。

## 対象範囲

* **対象範囲:** 約100%
* **国:** ブラジル
* **サービスID:** `bra_cpf`
* **データ領域:** 本人情報
* **カテゴリ：** TaxRegistry

## 入力

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

* **必須入力:** `tax_number`、`date_of_birth`
* **任意入力:** `first_name`、`last_name`、`vendor_data`
* **同意:** 不要
* **ワークフローでの利用:** ワークフローで利用可能
* **対象範囲:** 約100%
* **料金:** 成功したクエリ1件あたり\$0.20

このサービスが受け付けるすべての書類に、照会に使用する識別番号が記載されているわけではありません。書類から識別番号が抽出されない場合、チェックは**該当なし**として記録されます。この場合、データベースへの照会は行われず、料金も発生しませんが、国によっては実際のユーザーの大きな割合がこれに該当します。こうしたユーザーにも対応するには、アンケートの回答、Document AIの抽出フィールド、またはセッション作成時に送信する値からも識別番号を収集し、データベース検証ステップでマッピングしてください。

## ボディパラメーター

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

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

例: `BRA`

**services** `string` *required* (default: bra\_cpf)

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

例: `bra_cpf`

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

税務上の識別番号です。

例: `11111111111`

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

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

例: `1990-01-01`

**first\_name** `string`

検証する名(ファーストネーム)です。

例: `John`

**last\_name** `string`

検証する姓(ラストネーム)です。

例: `Doe`

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

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

例: `user-1234`

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

* ブラジルのCPF（11桁）
* `tax_number`は数字のみで構成する必要があります。リクエストを送信する前に、スペース、ハイフン、句読点を削除してください。
* `tax_number`は11文字である必要があります。

## 呼び出し方法

```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_cpf" \
  -F "vendor_data=user-1234" \
  -F "tax_number=11111111111" \
  -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_cpf"],
    date_of_birth="1990-01-01",
    tax_number="11111111111",
    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_cpf"],
  date_of_birth: "1990-01-01",
  tax_number: "11111111111",
  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_cpf"}),
	DateOfBirth:  didit.String("1990-01-01"),
	TaxNumber:    didit.String("11111111111"),
	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_cpf"))
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .taxNumber("11111111111")
        .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_cpf'],
    'date_of_birth' => '1990-01-01',
    'tax_number' => '11111111111',
    '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_cpf"],
  date_of_birth: "1990-01-01",
  tax_number: "11111111111",
  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_cpf" },
    DateOfBirth = "1990-01-01",
    TaxNumber = "11111111111",
    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_cpf",
      "service_name": "Brazil - CPF status check",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "lgpd_minor": "sample_value",
        "minor_under_16": "sample_value",
        "minor_under_18": "sample_value",
        "registration_date": "1990-01-01"
      },
      "validation": {
        "date_of_birth": "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_cpf",
      "service_name": "Brazil - CPF status check",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "lgpd_minor": "sample_value",
        "minor_under_16": "sample_value",
        "minor_under_18": "sample_value",
        "registration_date": "1990-01-01"
      },
      "validation": {
        "date_of_birth": "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_cpf",
      "service_name": "Brazil - CPF status check",
      "source_data": {
        "date_of_birth": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "date_of_birth": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返されるデータ

`source_data`に含まれる具体的なフィールドは、登録機関が返す内容によって異なります。`bra_cpf`向けに生成された例では、現在次の正規化された構造が記載されています。

* `date_of_birth`
* `first_name`
* `identification_number`
* `last_name`
* `lgpd_minor`
* `minor_under_16`
* `minor_under_18`
* `registration_date`

## 料金と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.