curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.retrieve(
"company-123",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.retrieve("company-123");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.Retrieve(ctx, "company-123")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().retrieve("company-123");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->retrieve('company-123');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.retrieve("company-123")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Businesses.RetrieveAsync("company-123");
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
"vendor_data": "company-123",
"display_name": null,
"legal_name": "Acme Trading Ltd",
"registration_number": "12345678",
"country_code": "GB",
"effective_name": "Acme Trading Ltd",
"status": "ACTIVE",
"session_count": 2,
"approved_count": 1,
"declined_count": 0,
"in_review_count": 1,
"features": {
"KYB": "Approved"
},
"features_list": [
{
"feature": "KYB",
"status": "Approved"
}
],
"last_session_at": "2026-03-15T10:30:00Z",
"last_activity_at": "2026-03-15T10:30:00Z",
"first_session_at": "2026-01-10T08:00:00Z",
"tags": [
{
"uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"name": "VIP",
"color": "#2567FF"
}
],
"created_at": "2026-01-10T08:00:00Z",
"metadata": {
"industry": "fintech"
},
"updated_at": "2026-03-15T10:30:00Z"
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Not found."
}{
"detail": "Request was throttled. Expected available in 30 seconds."
}企業取得API(KYB):vendor_dataで企業を1件取得
Didit Management APIで、vendor_dataを指定してKYB企業を1件取得します。法人登記由来の識別情報、ステータス、KYB集計カウンター、機能マップを返します。呼び出しごとの従量課金です。
curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.retrieve(
"company-123",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.retrieve("company-123");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.Retrieve(ctx, "company-123")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().retrieve("company-123");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->retrieve('company-123');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.retrieve("company-123")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Businesses.RetrieveAsync("company-123");
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
"vendor_data": "company-123",
"display_name": null,
"legal_name": "Acme Trading Ltd",
"registration_number": "12345678",
"country_code": "GB",
"effective_name": "Acme Trading Ltd",
"status": "ACTIVE",
"session_count": 2,
"approved_count": 1,
"declined_count": 0,
"in_review_count": 1,
"features": {
"KYB": "Approved"
},
"features_list": [
{
"feature": "KYB",
"status": "Approved"
}
],
"last_session_at": "2026-03-15T10:30:00Z",
"last_activity_at": "2026-03-15T10:30:00Z",
"first_session_at": "2026-01-10T08:00:00Z",
"tags": [
{
"uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"name": "VIP",
"color": "#2567FF"
}
],
"created_at": "2026-01-10T08:00:00Z",
"metadata": {
"industry": "fintech"
},
"updated_at": "2026-03-15T10:30:00Z"
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Not found."
}{
"detail": "Request was throttled. Expected available in 30 seconds."
}概要
vendor_dataをキーとして、単一の企業エンティティを返します。
使用する場面
- 企業の現在の検証状態を確認。
featuresマップで、すべてのKYB機能の最新ステータスを一目で確認できます。 - 自社の管理UIにおける詳細ビュー。
- 集計カウンターと機能ステータスを用いたリスクスコアリング。
注意事項
- URL内の
vendor_dataは大文字と小文字が区別されます。 - 該当する
vendor_dataの企業が存在しない場合は404を返します。 - 集計カウンター(
session_count、approved_count、declined_count、in_review_count)は、法人確認 (KYB)セッションが完了するとリアルタイムで更新されます。 - 登記情報に由来するフィールド(
legal_name、registration_number、country_code)には、最新の承認済み法人確認 (KYB)セッションの内容が反映されます。
権限
役割にread:businessesが付与されている必要があります。
関連
承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
パスパラメータ
企業に対するお客様独自の識別子です。自由形式の文字列(UUIDではありません)で、送信されたとおりに完全一致で照合されます。
レスポンス
メタデータと集計されたセッションデータを含む企業の完全な詳細。
企業の完全な詳細。BusinessListItemにmetadataとupdated_atを追加したものです。
この企業に対するDiditの安定した内部UUIDです。
この企業に対するお客様独自の識別子です(セッション作成時に渡されたもの)。ベンダー識別子が指定されなかった場合はnullになることがあります。
お客様が設定したカスタム表示名
登記簿または手動入力による正式な法人名
会社の登記番号または設立番号
設立国(ISO 3166-1 alpha-2、例: GB、US)。
利用可能な最適な名前:display_nameが設定されていればそれを、設定されていなければlegal_nameを使用
企業レコードのライフサイクルステータス(セッションのステータスではありません)。ACTIVEがデフォルトで、FLAGGEDは手動での確認対象としてマークし、BLOCKEDはこのvendor_dataでの新規セッションを禁止します。
ACTIVE, FLAGGED, BLOCKED この企業の認証セッションの総数
承認済みセッションの数
却下されたセッションの数
レビュー中のセッション数
この企業のすべてのKYBセッションを通じた、機能ごとの集計ステータスです。現在のキーはKYB(登記上の企業チェックのステータス)のみです。取り得る値はApproved、Declined、In Review、Not Finished、Resub Requestedです。
featuresと同じデータを、{feature, status}オブジェクトの順序付き配列で表したもの。
Show child attributes
Show child attributes
直近のセッションの日時
最初のセッションの日時
直近のアクティビティ(ステータス変更、セッション更新など)の日時
この企業に割り当てられたタグ
Show child attributes
Show child attributes
この企業に付加したカスタムメタデータJSON。デフォルトは{}です。