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));企業更新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));概要
企業エンティティの変更可能なフィールドを更新します。法人登記の照会から取得されたフィールド(legal_name、registration_number、country_code)は、最初の法人認証 (KYB) セッションが承認済みになった後は読み取り専用になります。
使用するタイミング
- 名前を変更: 社内向けの表示用に、より適切な
display_nameを設定します。 - メタデータの更新: 企業を社内のレベル間で移動する、社内メモを記録する、タグを変更する、といった用途に使います。
- 法人登記データの上書き(注意して使用): 上書きは受け付けられますが、監査ログでフラグが付けられます。
注意事項
- URL内の
vendor_dataは、このエンドポイントでは変更できません。 changed_fields配列を含むbusiness.data.updatedWebhookを送信します。- すべての編集は、Business Consoleの企業のActivityに記録されます。
statusの変更は指定されている場合はreason(最大1000文字)とともに記録され、display_name、legal_name、registration_number、country_codeまたはmetadataの変更はプロフィールの更新として記録されます。business.status.updatedWebhookにはreasonは含まれません。
権限
プライマリシークレットとフルアクセスのAPIキーは、常にこのエンドポイントを呼び出せます。 カスタムアクセスのキーには、Companies(businesses)の書き込み権限が必要です。
一部のワークフローまたは承認済みセッションに制限されたキーは、このエンドポイントにアクセスできません。
Consoleの役割と権限は、チームメンバーがConsoleで実行できる操作を決めるものです。
APIキーによるリクエストでは評価されません。
関連情報
承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
パスパラメータ
企業に対するお客様独自の識別子です(自由形式の文字列で、UUIDではありません)。
ボディ
部分更新ボディ。変更したいフィールドのみを指定してください。
コンソールに表示されるわかりやすい表示名(UI表示ではlegal_nameより優先されます)。
登記簿または手動入力による正式な法人名。
法人の登記番号または設立番号。
設立国(ISO 3166-1 alpha-2、例: GB、US)。
企業のライフサイクルステータス。BLOCKEDを設定すると、vendor_dataが自動的にシステムのブロックリストに追加されます。BLOCKEDから別のステータスに変更すると、そのブロックリストのエントリは削除されます。
ACTIVE, FLAGGED, BLOCKED 企業に付与する任意のJSONオブジェクト。更新時には既存のメタデータを完全に置き換えます。キーを追加したいだけの場合は、クライアント側でマージしてください。
ステータスが変更された理由。Business Consoleの企業のActivityにあるステータス変更エントリに記録されます。記録されるのは、ステータスが実際に変わった場合のみです。Webhookには含まれません。
1000レスポンス
企業を更新しました。更新後の企業の完全なレコードが返されます。
企業の完全な詳細。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。デフォルトは{}です。