curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Acme Corp", "status": "FLAGGED"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.update(
"company-123",
display_name="Acme Corp",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.update("company-123", {
display_name: "Acme Corp",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.Update(ctx, "company-123", didit.BusinessesUpdateParams{
DisplayName: didit.String("Acme Corp"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.BusinessesUpdateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().update("company-123", BusinessesUpdateParams.builder()
.displayName("Acme Corp")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->update('company-123', [
'display_name' => 'Acme Corp',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.update(
"company-123",
display_name: "Acme Corp"
)
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.UpdateAsync("company-123", new BusinessesUpdateParams
{
DisplayName = "Acme Corp",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
"vendor_data": "company-123",
"display_name": "Acme Corp",
"legal_name": "Acme Trading Ltd",
"registration_number": "12345678",
"country_code": "GB",
"effective_name": "Acme Corp",
"status": "FLAGGED",
"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",
"risk_level": "low"
},
"updated_at": "2026-03-15T10:30:00Z"
}Didit 更新企业 API:修改企业 KYB 实体
Didit 可更新企业(KYB)的可变字段:显示名称、元数据、标签。注册表衍生的身份字段不可修改。按次计费的 KYB 管理。
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Acme Corp", "status": "FLAGGED"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.update(
"company-123",
display_name="Acme Corp",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.update("company-123", {
display_name: "Acme Corp",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.Update(ctx, "company-123", didit.BusinessesUpdateParams{
DisplayName: didit.String("Acme Corp"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.BusinessesUpdateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().update("company-123", BusinessesUpdateParams.builder()
.displayName("Acme Corp")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->update('company-123', [
'display_name' => 'Acme Corp',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.update(
"company-123",
display_name: "Acme Corp"
)
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.UpdateAsync("company-123", new BusinessesUpdateParams
{
DisplayName = "Acme Corp",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
"vendor_data": "company-123",
"display_name": "Acme Corp",
"legal_name": "Acme Trading Ltd",
"registration_number": "12345678",
"country_code": "GB",
"effective_name": "Acme Corp",
"status": "FLAGGED",
"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",
"risk_level": "low"
},
"updated_at": "2026-03-15T10:30:00Z"
}概述
更新企业实体上的可变字段。从注册信息查询中填充的字段(legal_name、registration_number、country_code)在首次通过的企业验证(KYB)会话后变为只读。
适用场景
- 重命名:设置更便于内部查看的
display_name。 - 更新元数据:在内部等级之间调整企业的级别,记录内部备注,或更改标签。
- 覆盖注册信息(请谨慎操作):覆盖会被接受,但会在审计日志中标记。
注意事项
- URL 中的
vendor_data无法通过此 endpoint 更改。 - 会发出包含
changed_fields数组的business.data.updatedWebhook。 - 每次编辑都会记录在 Business Console 中该公司的活动里。
status变更会记录可选的reason(最多 1000 个字符)。对display_name、legal_name、registration_number、country_code或metadata的更改则记录为资料更新。business.status.updatedWebhook 不包含reason。
权限
主密钥和拥有完全访问权限的 API 密钥始终可以调用此 endpoint。 具有自定义访问权限的密钥需要具备企业(businesses)的写入权限。
仅限部分工作流或仅限已通过会话的密钥无法访问此 endpoint。
Console 中的角色与权限决定团队成员在 Console 中可以执行的操作。这些设置不适用于 API 密钥请求。
相关内容
授权
您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。
路径参数
您对该企业的唯一标识符(自由格式字符串,非 UUID)。
请求体
部分更新请求体。仅提供您想要更改的字段。
控制台中显示的易读显示名称(在界面显示时优先级高于 legal_name)。
来自登记处或手动输入的官方法定名称。
企业注册号或成立号。
注册国家/地区(ISO 3166-1 alpha-2,例如 GB、US)。
企业生命周期状态。设置为 BLOCKED 会自动将 vendor_data 添加至系统黑名单;从 BLOCKED 切出则会移除该黑名单条目。
ACTIVE, FLAGGED, BLOCKED 您附加到企业的任意 JSON 对象。更新时将完全替换现有元数据。如果仅想添加键,请在客户端进行合并。
状态变更的原因。仅在状态实际变更时,记录在 Business Console 中该企业的 Activity 状态变更条目上。Webhook 不包含此项。
1000响应
企业已更新。返回完整的已更新企业记录。
完整企业详情。在 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。默认为 {}。