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:通过 vendor_data 查询 KYB 企业实体
通过 vendor_data 获取单个 Didit 企业(KYB)信息,包括注册表衍生的身份、状态、汇总的 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 功能的最新状态。 - 在您自己的管理后台中展示详情视图。
- 结合汇总计数器和功能状态进行风险评分。
注意事项
- 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 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。
路径参数
您对该企业的唯一标识符,为自由格式字符串(非 UUID),按发送的内容精确匹配。
响应
完整企业详情,包含元数据和聚合会话数据。
完整企业详情。在 BusinessListItem 基础上扩展了元数据和 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。默认为 {}。