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

# ブラジル Unico IDCloud（CPF + セルフィー）本人確認API

> Didit経由でブラジルの公的データベースを照会するUnico IDCloud（CPF + セルフィー）認証。1回$0.20からの従量課金で、契約や最低利用額はありません。

Unico IDCloudの生体認証による検証では、ユーザーのセルフィーをそのCPFに登録されている顔と照合し、同一人物である、同一人物ではない、判定不能のいずれかを返します。Diditはこのサービスを`POST /v3/database-validation/`で提供しているため、送信されたデータを公式の情報源と照合し、正規化された照合結果を受け取ることができます。

## カバレッジ

* **カバレッジ：** 96%
* **国：** ブラジル
* **サービスID：** `bra_unico_idcloud`
* **データ領域：** 本人情報
* **カテゴリ：** BiometricRiskScore

ブラジルのCPF保有者の約96%が、Unicoのレジストリにある生体認証レコードに該当します。これは、政府の顔照合ソースである[Datavalid](https://docs.didit.me/ja/api-reference/database-validation/brazil/cpf-facial.md)のカバレッジ(約50%)のおよそ2倍です。

## 入力

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

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

## ボディパラメーター

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

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

例：`BRA`

**services** `string` *required* (default: bra\_unico\_idcloud)

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

例：`bra_unico_idcloud`

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

このサービスに対するエンドユーザーの明示的な同意。

例：`true`

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

税務上の識別番号。

例：`11111111111`

**selfie** `file` *required*

生体認証によるデータベース検証のためにアップロードするセルフィー画像ファイル。対応形式：JPEG、PNG、WebP。

例：`@./selfie.jpg`

**first\_name** `string`

検証する名。

例：`John`

**last\_name** `string`

検証する姓。

例：`Doe`

**full\_name** `string`

検証する法的な氏名。

例：`John Doe`

**date\_of\_birth** `string`

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

例：`1990-01-01`

**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_unico_idcloud" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "tax_number=11111111111" \
  -F "selfie=@./selfie.jpg"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="BRA",
    services=["bra_unico_idcloud"],
    consent=True,
    tax_number="11111111111",
    vendor_data="user-1234",
    selfie=open("selfie.jpg", "rb"),
)
print(result)
```

```javascript Node.js theme={null}
import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "BRA",
  services: ["bra_unico_idcloud"],
  consent: true,
  tax_number: "11111111111",
  vendor_data: "user-1234",
  selfie: await fileFromPath("selfie.jpg"),
});
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_unico_idcloud"}),
	Consent:      didit.Bool(true),
	TaxNumber:    didit.String("11111111111"),
	VendorData:   didit.String("user-1234"),
	Selfie:       didit.Some(didit.FileFromPath("selfie.jpg")),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.nio.file.Path;
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_unico_idcloud"))
        .consent(true)
        .taxNumber("11111111111")
        .vendorData("user-1234")
        .selfie(Path.of("selfie.jpg"))
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'BRA',
    'services' => ['bra_unico_idcloud'],
    'consent' => true,
    'tax_number' => '11111111111',
    'vendor_data' => 'user-1234',
    'selfie' => File::fromPath('selfie.jpg'),
]);
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_unico_idcloud"],
  consent: true,
  tax_number: "11111111111",
  vendor_data: "user-1234",
  selfie: Pathname("selfie.jpg")
)
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_unico_idcloud" },
    Consent = true,
    TaxNumber = "11111111111",
    VendorData = "user-1234",
    Selfie = FileUpload.FromPath("selfie.jpg"),
});
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_unico_idcloud",
      "service_name": "BRA - Unico IDCloud (CPF + selfie)",
      "source_data": {
        "unico_face_match": "yes"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`BIOMETRIC_NO_MATCH`**：顔照合のスコアが承認しきい値を下回りました。セルフィーはレジストリの写真と同一人物ではありません。

```json 200 OK — BIOMETRIC_NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "BRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_NO_MATCH",
      "service_id": "bra_unico_idcloud",
      "service_name": "BRA - Unico IDCloud (CPF + selfie)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`INCONCLUSIVE`**：レジストリはその人物がレジストリの情報と一致するかどうかを判断できませんでした。結果は不確定です(レジストリに登録されている場合も、されていない場合もあります)。これは不一致ではなく、画像の技術的な問題でもありません。どのフィールドについても判定されないため、match\_typeはnullとなり、チェックはレビューに回されます。

```json 200 OK — INCONCLUSIVE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "BRA",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "INCONCLUSIVE",
      "service_id": "bra_unico_idcloud",
      "service_name": "BRA - Unico IDCloud (CPF + selfie)",
      "source_data": {},
      "validation": {}
    }
  ]
}
```

## 返されるデータ

`source_data`に含まれる具体的なフィールドは、レジストリが返す内容によって異なります。`bra_unico_idcloud`の生成済みの例では、現在、次の正規化された形式が記載されています。

* `unico_face_match`

## 料金とSLA

BRA - Unico IDCloud(CPF+セルフィー)のクエリは、Diditが検証ソースから確定的な結果を受け取った場合にのみ課金されます。

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

## このデータソースについて

[Unico](https://unico.io)は、ブラジル最大の民間顔生体認証データベースを運営するブラジルのIDテック企業です。同社のIDCloudプラットフォームは10億件を超える顔エンベディングを保有し、毎月約3,500万件の新しい顔が追加されています。これらのデータは、ブラジルの5大銀行のうち4行を含む800社以上のブラジル企業のオンボーディングおよび再認証フローから提供されています。この規模が上記のカバー率を支えており、CPFで照会すると、ブラジルの成人の約96%について生体認証記録が見つかります。

DiditはUnicoと直接提携しているため、標準のデータベース検証APIを通じてIDCloudに照会できます。呼び出しごとの従量課金で、Unicoとの個別契約、最低利用量、オンボーディング手続きはいずれも不要です。

**政府の登録データベースとの違い。** Diditは[ブラジル - CPF + 顔照合(Datavalid)](https://docs.didit.me/ja/api-reference/database-validation/brazil/cpf-facial.md)も提供しています。これはSERPROの公式ソースであり、政府の登録データベースを信頼できる情報源として特に必要とする場合に適した選択肢です。それ以外のすべての用途では、確認可能な2つの観点からIDCloudの方が優れています。Datavalidのカバー率が成人の約50%であるのに対し、IDCloudは約96%に達します。また、ユーザーから提出された書類の顔写真ではなく、IDCloudが自ら管理する生体認証記録と照合するため、書類偽造とCPF盗用による不正の両方に強い耐性があります。さらに、1回の照会あたりの料金は半額未満です。

## ブラジル向けの推奨フロー

ブラジルのほとんどのユースケースでは、書類の撮影はまったく必要ありません。ユーザーがCPFを入力し、ライブネス検知済みのセルフィーによって、そのCPFの本人であることを確認します。

**1. CPFを収集する**

テキスト入力は11桁のCPFのみです。書類の写真も、氏名や生年月日の手入力も必要ありません。

このフローでは書類を読み取らないため、CPFの取得元を指定しない限り、DiditにはCPFを取得する手段がありません。セッション作成時にセッションの`metadata`でCPFを送信し、それをデータベース検証ステップの`tax_number`入力にマッピングしてください。Business Consoleではステップの入力マッピング、ワークフローAPIではノードの`database_validation_field_sources`で設定します。

```json theme={null}
{
  "database_validation_countries": {"BRA": {"services": ["bra_unico_idcloud"]}},
  "database_validation_field_sources": {
    "tax_number": {"source": "expected_data", "key": "metadata.cpf"}
  }
}
```

そのうえで、各セッションをそのキーに値を入れて作成します。

```json theme={null}
{"workflow_id": "<workflow_id>", "metadata": {"cpf": "12345678909"}}
```

マッピングがない場合もステップ自体は実行されますが、`tax_number`が欠落していると報告され、レジストリへの照会は一切行われません。料金は発生せず、セッションの`database_validations`エントリにその理由が記録されます。

**2. ライブネス検知付きでセルフィーを撮影する**

同じワークフローに[ライブネス検知](https://docs.didit.me/ja/core-technology/liveness/overview.md)ステップを追加し、リスク許容度に合った方式を選択します。**パッシブライブネス**（ユーザーの操作は一切不要）、**3Dフラッシュ**、**3Dアクション＆フラッシュ**（光のパターンを投影するアクティブ方式で、後者はさらにランダムなアクションを加えます）から選べます。Business ConsoleまたはワークフローAPIで、`face_liveness_method`（`PASSIVE`、`FLASHING`、`ACTIVE_3D`）を使って設定します。どの方式を選んでも、Diditが撮影ステップを表示し、実在する本人がその場にいることを確認します。これにより、保存済みの写真や画面の再生映像が送信されるのを防ぎます。

**3. Unico IDCloudでCPFとセルフィーを検証する**

セッションフロー内では、Diditがライブネス検知のセルフィーを自動的に再利用するため、画像を扱う必要はありません。CPFは上記のマッピングから読み取られます。続いてIDCloudが、その顔がCPFの持ち主のものかどうかを確認します。このステップに必要な入力はこの2つだけです。`metadata`で`full_name`や`date_of_birth`も送信してマッピングした場合は、照合用としてUnicoに渡されますが、必須ではありません。

> [!NOTE]
>
> このCPFのみのフローは、Diditが撮影を行い、ライブネス検知のセルフィーをこのサービスに渡す**セッションおよびワークフロー**連携に適用されます。`POST /v3/database-validation/`を**直接**呼び出す場合、`selfie`は必須のファイル入力となり、画像はご自身で用意する必要があります。両方のモードについては[データベース検証の概要](https://docs.didit.me/ja/core-technology/database-validation/overview.md)を参照してください。

**コスト:** パッシブライブネスの場合、認証済みユーザー1人あたり約\$0.30です（IDCloudへの照会が\$0.20、ライブネス検知が\$0.10）。アクティブ方式ではライブネス検知が\$0.15となるため、約\$0.35です。これらは定価であり、それぞれにプランの割引が適用されます。詳しくは[料金](https://docs.didit.me/ja/getting-started/pricing.md)を参照してください。

**カバー対象外となる約4%へのフォールバック。** IDCloudが`INCONCLUSIVE`を返した場合、レジストリはそのCPFを利用可能な生体情報レコードに結び付けられなかったことを意味します。通常は、その人物がレジストリに登録されていないことが原因です。これは検証の失敗ではなく「回答なし」として扱い、完全な[本人確認](https://docs.didit.me/ja/core-technology/id-verification/overview.md)（書類の撮影と、書類の顔写真に対する顔照合）にフォールバックしてください。これにより全員を検証可能な状態に保ちつつ、書類検証の料金はごく一部の残りのユーザーにのみ発生します。

**却下への対応。** `BIOMETRIC_NO_MATCH`は、レジストリが明確に不一致と判断したことを意味します。つまり、その顔はそのCPFの持ち主のものではありません。これは再試行を促すものではなく、強い否定的結果として扱ってください。ユーザーをそのまま書類撮影に誘導するのは、まさになりすましを図る者が望む経路です。書類は彼らが手元で用意できるものだからです。とはいえ、外見の変化、古いレジストリ写真、撮影品質の低さなどにより、本当の偽陰性も発生します。そのため、自動承認したりユーザーを行き止まりにしたりするのではなく、手動レビューに回してください。`BIOMETRIC_IMAGE_UNUSABLE`はこれとは異なり、セルフィーを読み取れなかっただけなので、新しいセルフィーを依頼してください。各結果がセッションにどう影響するかは[部分一致・不一致時のアクション](https://docs.didit.me/ja/core-technology/database-validation/database-validation-warnings.md)で設定でき、全一覧は[結果コード](https://docs.didit.me/ja/core-technology/database-validation/database-validation-outcome-codes.md)を参照してください。

**リピーターユーザー。** レジストリへの照会料金は一度だけで済みます。ユーザーがこのフローを通過すると、ライブネス検知のセルフィーがそのユーザーの`vendor_data`に紐付けて保存されるため、後から[生体認証](https://docs.didit.me/ja/core-technology/biometric-auth/overview.md)（ライブネス検知と、保存された顔に対する顔照合）を使って\$0.10で再検証できます。ライブネス検知の方式も同じく選択できます。なお、これは**リピーター**ユーザー専用です。生体認証セッションには保存済みの顔（またはご自身で用意した`portrait_image`）が必要で、どちらもない場合はセッション作成時に失敗します。そのため、初回のユーザーは引き続き上記のフローを経由します。

## 関連情報

* [ブラジルのデータベース検証の概要](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.