メインコンテンツへスキップ
POST
cURL
アプリケーションのAPIキーを使用して、バックエンドからSmart-ID認証を開始します。 ワークフローやworkflow_idは不要です。 開始時のレスポンスは次の認証アクションを示すものであり、承認済みの本人確認結果ではありません。

対応範囲と有効化

ウォレットの有効化は、APIのデプロイやアプリケーションの利用資格とは別に行われます。 エンドポイントがドキュメントに記載されていても、Coming soonと表示されているウォレットが有効化されるわけではありません。 現在の公開料金については、デジタルIDウォレットの料金を参照してください。

本人が行うこと

アプリケーションに照合コードを表示し、本人がスマートフォンで承認するまで待機します。 本人はPINをスマートフォンで入力します。アプリケーションやAPIリクエストで入力することは決してありません。 リクエスト例にあるすべてゼロの識別子は、Didit のサンドボックスでのシミュレーション専用です。本番環境での認証には、本人の登録情報を使用してください。

結果を受け取る

デジタルIDウォレットAPIガイドに従って、認証を追跡し、その結果を取得します。 ウォレットが本人を認証した証拠として扱えるのは、完了して検証済みとなった結果のみです。 返される本人属性はウォレットによって異なります。住所、顔写真、またはリクエストしたすべての属性が含まれているとは限りません。

関連情報

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ヘッダー

Idempotency-Key
string

任意の再試行安全キーです(最大255文字)。同じキー、ウォレット、リクエストボディで再試行すると、2回目のサインインを開始せずに元の検証結果が返されます。同じキーで別のウォレットまたはリクエストボディを指定すると、409 idempotency_key_reusedが返されます。

ボディ

Smart-IDによる認証を開始します(EST、LVA、LTU、BEL)。

country
enum<string>
必須

Smart-ID IDの国を示すISO 3166-1 alpha-3コード。

  • EST - EST
  • LVA - LVA
  • LTU - LTU
  • BEL - BEL
利用可能なオプション:
EST,
LVA,
LTU,
BEL
personal_code
string
必須

ユーザーの国民個人識別コード。ユーザーのSmart-IDアプリを指定するために使用され、ユーザーはアプリで照合コードを確認してPINを入力します。PINは絶対に収集しないでください。

Minimum string length: 1
Pattern: ^[0-9-]{6,20}$
vendor_data
string | null

この認証に対するお客様独自の参照値です(例:お客様のユーザーID)。結果とWebhookで返されます。

metadata
object | null

認証とともに保存され、結果とWebhookで返される任意のJSONオブジェクトです。

sandbox_scenario
string

サンドボックスアプリケーション専用:シミュレートする結果です。'wallet_cancelled'、'wallet_timeout'、'wallet_provider_error'のいずれかを指定し、それ以外のシナリオ(または指定なし)は検証済みになります。本番アプリケーションでは拒否されます。全カタログはGET /v1/sandbox/scenarios/で確認できます。

Minimum string length: 1

レスポンス

すべてのウォレットエンドポイントが返す形式の、単独のウォレット検証1件です。

request_id
string<uuid>
必須
wallet_verification
object
必須
vendor_data
string | null
必須
metadata
object | null
必須

開始時に送信されたmetadataオブジェクト、またはnullです。

created_at
string<date-time>
必須
最終更新日 2026年11月1日