本人確認と取引リスク管理 API
プラットフォームの API キーを使って、お客様のシステムから個人認証(KYC)、法人認証(KYB)、取引モニタリング、ウォレットアドレスのスクリーニングを開始し、チェック記録を照会できます。オープン API とコンソールは同じチェックの流れで動作し、単価も、結果・返金・照合のルールも同じです。
まずコンソールの「本人確認と取引リスク管理」で「有効にする」をクリックし、次に「API 管理」でキーを作成して「検証とリスク」の権限にチェックを入れてください。verification.read は単価と記録の照会に、verification.write はチェックの開始に使います。チェックを開始するたびにアカウント残高から課金されます。
エンドポイント
- GET /api/v1/verification/info:このアカウントが有効化済みかどうか、四種類のチェックそれぞれの提供状況と単価(米ドル)、取引モニタリングとウォレットスクリーニングで選択できるネットワークとアセットを返します。提供されていない種類には価格を返しません。
- POST /api/v1/verification/checks:チェックを開始します。課金と記録の作成は同じリクエスト内で行われます。本人確認では引き継ぎリンク handoff_url が返されるので、被確認者に送ってください。取引モニタリングとウォレットスクリーニングは通常、結果を直接返します。
- GET /api/v1/verification/checks:一覧は開始日時の新しい順に並び、kind、status、verdict、keyword(ID / アドレス / 課金番号)で絞り込めます。page と page_size でページ分割します(ページあたり最大 100 件)。単一の照会では、セッションがまだ被確認者の手元にある間は handoff_url も返します。更新ではプロバイダーから結果を読み直します(ウォレットスクリーニングは更新できず、もう一度チェックすると再度課金されます)。
同じ idempotency_key・同じ内容で再試行すると元の記録が返され、再度課金されることはありません。同じキーで内容を変えると拒否されます(400)。同じ対象 ID で未完了の本人確認を再度開始すると元のセッションが返され(reused が true)、この場合も課金されません。
結果コールバック
コンソールの「連携設定」で https のコールバック URL を入力して有効にします。チェック記録のステータスや結果が非同期に変わったとき(本人確認の完了、手動審査による結果の変更、取引結果の更新、失敗による返金)、プラットフォームはイベントを POST します。お客様自身が開始した呼び出しについてはプッシュしません。同期レスポンスにすでに結果が含まれているためです。
リクエストヘッダー X-Tovanix-Event はイベントの種類(check.updated、またはテスト用の ping)、X-Tovanix-Delivery は event_id、X-Tovanix-Timestamp は Unix 時間(秒)、X-Tovanix-Signature は sha256= に続けて HMAC-SHA256(署名シークレット, タイムスタンプ + "." + 生のリクエストボディ) を hex で表したものです。
相手側が 2xx を返した時点で配信成功とみなします。それ以外(タイムアウトを含む)は 1 分、5 分、15 分、1 時間、3 時間、6 時間、12 時間の間隔でバックオフしながら再試行し、最大 8 回で打ち切ります。再試行では同じ event_id と同じイベント本文を送るため、event_id で重複排除してください。イベントは順不同で届くことがあります。data.updated_at が新しいほうを採用するか、受信後に照会エンドポイントを呼び出して最新の状態を取得してください。コールバックを無効にすると、未配信のイベントは送信されなくなります。
関連ページ: 本人確認と取引リスク管理 · 本人確認:個人と法人 · 取引リスク審査:取引モニタリングとウォレットスクリーニング · API 連携ドキュメント
読み込み中…