はじめに
連携 / SDK
ユーザー認証
法人確認
トランザクションモニタリング
変更履歴curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/?status=active,in_review&ordering=-risk_score' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
for item in client.networks.list():
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();
for await (const item of didit.networks.list()) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
iter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();
for (var item : client.networks().list()) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
foreach ($didit->networks->list() as $item) {
print_r($item->toArray());
}require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
didit.networks.list.auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();
await foreach (var item in await client.Networks.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 123,
"next": 123,
"previous": 123,
"results": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"network_id": "<string>",
"name": "<string>",
"status": "active",
"risk": {
"score": 123,
"band": "low",
"bar": 123
},
"pattern_types": [
"exact_same_device"
],
"signal_types": [
"ip_address"
],
"member_counts": {},
"member_status": {},
"signal_coverage": {},
"first_activity_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z"
}
],
"sharing_mode": "global",
"cross_org_available": true,
"cross_org_unavailable_reason": null,
"kpis": {
"active": {},
"in_review": {},
"applicants_involved": {},
"detected_this_period": {},
"false_positive_rate": {}
},
"counts": {
"scopes": {
"all": 123,
"identity": 123,
"transactions": 123
},
"views": {
"all": 123,
"active": 123,
"in_review": 123,
"resolved": 123,
"dismissed": 123,
"mine": 123,
"high_risk": 123
},
"facets": {
"total": 123,
"last_activity_days": {
"7": 123,
"30": 123,
"90": 123
},
"risk_min": {
"50": 123,
"80": 123
},
"signal_types": {
"ip_address": 123,
"device": 123,
"face": 123,
"document_number": 123,
"phone": 123,
"email": 123,
"address": 123
},
"priority": {
"low": 123,
"medium": 123,
"high": 123,
"none": 123
},
"assignee": {
"me": 123,
"unassigned": 123,
"users": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "<string>",
"count": 123
}
]
},
"has_case": 123,
"min_size": {
"10": 123
}
}
}
}不正ネットワーク一覧取得API
Diditの組織内で検出された不正ネットワークを一覧取得します。ステータス、シグナル、パターン、リスク帯、規模、日付で絞り込みでき、共有モードと一覧の件数も返します。
curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/?status=active,in_review&ordering=-risk_score' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
for item in client.networks.list():
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();
for await (const item of didit.networks.list()) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()
iter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();
for (var item : client.networks().list()) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();
foreach ($didit->networks->list() as $item) {
print_r($item->toArray());
}require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
didit.networks.list.auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();
await foreach (var item in await client.Networks.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 123,
"next": 123,
"previous": 123,
"results": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"network_id": "<string>",
"name": "<string>",
"status": "active",
"risk": {
"score": 123,
"band": "low",
"bar": 123
},
"pattern_types": [
"exact_same_device"
],
"signal_types": [
"ip_address"
],
"member_counts": {},
"member_status": {},
"signal_coverage": {},
"first_activity_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z"
}
],
"sharing_mode": "global",
"cross_org_available": true,
"cross_org_unavailable_reason": null,
"kpis": {
"active": {},
"in_review": {},
"applicants_involved": {},
"detected_this_period": {},
"false_positive_rate": {}
},
"counts": {
"scopes": {
"all": 123,
"identity": 123,
"transactions": 123
},
"views": {
"all": 123,
"active": 123,
"in_review": 123,
"resolved": 123,
"dismissed": 123,
"mine": 123,
"high_risk": 123
},
"facets": {
"total": 123,
"last_activity_days": {
"7": 123,
"30": 123,
"90": 123
},
"risk_min": {
"50": 123,
"80": 123
},
"signal_types": {
"ip_address": 123,
"device": 123,
"face": 123,
"document_number": 123,
"phone": 123,
"email": 123,
"address": 123
},
"priority": {
"low": 123,
"medium": 123,
"high": 123,
"none": 123
},
"assignee": {
"me": 123,
"unassigned": 123,
"users": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "<string>",
"count": 123
}
]
},
"has_case": 123,
"min_size": {
"10": 123
}
}
}
}qや、ステータス、シグナル、パターン、リスク帯の各チップも含まれます。
assignee、priority、risk_min、has_caseの各パラメーターは、counts.facetsが集計する担当者、優先度、最小リスク、紐づくケースの各オプションに対応します。
assignee=meにはコンソールメンバーのトークンが必要です。APIキーを使用した場合は400が返されます。
共有モードと組織横断シグナル
すべてのレスポンスには、組織のsharing_mode、cross_org_available、cross_org_unavailable_reasonが含まれます。
| フィールド | 意味 |
|---|---|
sharing_mode | 組織の組織横断共有モードです。組織をまたいでネットワークを比較するのはglobalのみです。privateとoffでは、組織自身の履歴の範囲に限定されます。 |
cross_org_available | 組織横断シグナルが組織に適用されるかどうかを示します。適用には、Enterpriseプランとglobal共有モードの両方が必要です。 |
cross_org_unavailable_reason | プランに組織横断の不正ネットワークが含まれない場合(Enterpriseプランが必要)は、共有モードにかかわらずplanになります。プランには含まれるものの、共有モードがprivateまたはoffの場合はsharing_modeになります。cross_org_availableがtrueの場合はnullになります。 |
globalであっても理由はplanになります。
件数とsummaryパラメーター
kpisはフィルターに一致するネットワークを集計し、countsはアプリケーションから参照できるすべてのネットワークを集計するため、どちらもページ本体の取得よりコストが高くなります。
ページとそのcountだけが必要な場合はsummary=falseを指定してください。この場合、レスポンスからkpisとcountsが省略されます。
summaryに指定できるのはtrueまたはfalseのみです。それ以外の値を指定すると400が返されます。
countsには、一覧のビューとフィルターオプションの背後にある数値が含まれ、各ネットワークは1回だけカウントされます。
| キー | 集計対象 |
|---|---|
scopes | 参照可能なすべてのネットワーク(all)。transactions(すべてのメンバーが取引の当事者であるもの)とidentity(それ以外のすべてのネットワーク)に分けて集計します。 |
views | 選択したscope内の参照可能なネットワーク(all)。ステータス別(active、in_review、resolved、dismissed)、呼び出し元のコンソールメンバーに割り当てられたもの(mine)、およびhigh_risk(リスクスコアが80以上で、却下されていないもの)を集計します。 |
facets | 選択したscopeとstatusビュー内のネットワーク(total)。直近のアクティビティ別(last_activity_days: 7、30、90)、最小リスク別(risk_min: 50、80)、シグナルの種類別、優先度別(noneを含む)、担当者別(me、unassigned、およびusers内の担当者ごとに1件)、アプリケーションがケースを作成したネットワーク(has_case)、メンバーが10人以上のネットワーク(min_size)を集計します。 |
scopeとstatus以外のフィルターはcountsに影響しません。
APIキーの場合、呼び出し元のコンソールメンバーが存在しないため、views.mineとfacets.assignee.meは常に0になります。
アクセス
ネットワークのエンドポイントには、フルアクセス権を持つAPIキーが必要です。 アクセスが制限されたキーには403が返されます。
コンソールメンバーのトークンにはlist:networksが必要です。
組織でネットワーク機能が有効になっていない場合、ネットワークのすべてのエンドポイントは"code": "networks_not_entitled"とともに403を返します。
関連情報
承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
クエリパラメータ
含めるステータスのカンマ区切りリスト:active,in_review,resolved,dismissed。省略するとdismissedは除外されます。
transactionsはメンバー全員が取引当事者であるネットワークを残し、identityはそれ以外のすべてのネットワークを残します。両方を対象にする場合は省略してください。counts.viewsとcounts.facetsも絞り込まれます。その他の値を指定すると400が返されます。
identity, transactions カンマ区切りのシグナルタイプ:ip_address,device,face,document_number,phone,email,address。
カンマ区切りのパターンタイプ(例:exact_same_device,same_email)。
カンマ区切りの区分: low,medium,high。
メンバー数の最小値。
最大メンバー数です。
カンマ区切りの担当者: unassigned、メンバーのメールアドレス（大文字と小文字を区別せずに照合）、または呼び出し元のコンソールメンバーを示すme。いずれかの値に一致するネットワークが該当します。meにはコンソールメンバーのトークンが必要です。APIキーの場合は400 {"assignee": ["\"me\" needs a user token; an API key has no assignee identity."]}が返されます。
カンマ区切りの優先度:low、medium、high、または優先度のないネットワークを示すnone。それ以外の値を指定すると、400({"priority": "Unknown priority: <values>."})が返されます。
リスクスコアの最小値。0〜100の整数です。整数以外の値を指定すると、400（{"risk_min": "Use a whole number from 0 to 100."}）が返されます。
0 <= x <= 100trueを指定するとアプリケーションがケースを開いたネットワークを、falseを指定するとそれ以外のネットワークを残します。それ以外の値は無視されます。
last_activity_atの下限（ISO 8601形式の日付または日時）。
first_activity_atの上限（ISO 8601形式の日付または日時）。
ネットワーク名、メンバー名、network_id（N-0001）、およびpattern_typeトークンの完全一致を対象とした自由記述検索。
risk_score、-risk_score、last_activity_at、-last_activity_at、first_activity_at、-first_activity_at、network_number、-network_numberのいずれかです。デフォルトは-risk_score,-last_activity_atです。
ページサイズ（1〜500）。デフォルトは100です。
1 <= x <= 500最初のレコードの0始まりのオフセットです。
x >= 0falseの場合、kpisとcountsを含めず、ページとそのcountのみを返します。デフォルトはtrueです。trueまたはfalse以外の値を指定すると400が返されます。
レスポンス
ページネーションされたネットワーク一覧。組織の共有モードと組織間での利用可否を含み、summary=falseでない限りkpisとcountsも含まれます。
次ページのオフセット。最終ページではnullです。
Show child attributes
Show child attributes
組織の組織間共有モード。globalのみが組織をまたいでネットワークを比較します。privateとoffでは、比較は組織自身の履歴内に限定されます。
off, private, global "global"
この組織に組織横断シグナルが適用されるかどうかです。Enterpriseプランとglobal共有モードの両方が必要です。
true
組織間シグナルが適用されない理由。以下の順にチェックされます。plan：組織のプランに組織間不正ネットワークが含まれていません（Enterpriseプランが必要です）。共有モードに関係なく該当します。sharing_mode：プランには含まれていますが、共有モードがprivateまたはoffです。cross_org_availableがtrueの場合はnullです。
plan, sharing_mode null
各キーは、現在のフィルターに一致する結果に対する{value, delta}です。summary=falseの場合は省略されます。
Show child attributes
Show child attributes
リストのビューとフィルターオプションごとのネットワーク数で、各ネットワークは1回だけカウントされます。summaryがfalseでない場合にのみ返されます。scopesは、アプリケーションから参照可能なすべてのネットワークをカウントします。viewsは、選択したscope内の参照可能なネットワークをカウントします。facetsは、選択したscopeとstatusビュー内のネットワークをカウントします（棄却済みのネットワークは、statusに含まれていない限り除外されます）。その他のリストフィルターは、これらのカウントに影響しません。
Show child attributes
Show child attributes