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

対応範囲と有効化

ウォレットの有効化は、APIのデプロイやアプリケーションの利用資格とは別です。 エンドポイントがドキュメントに記載されていても、「近日提供予定」と表示されているウォレットが有効になるわけではありません。 最新の公開料金については、デジタルIDウォレットの料金をご覧ください。

本人が行う操作

開始リクエストから返された次のアクションに従ってください。 本人がブラウザ、別のデバイス、アプリのいずれを使用するかは、ウォレットの認証フローによって決まります。

結果を受け取る

デジタル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が返されます。

ボディ

OneID認証を開始します(GBR)。

return_url
string<uri>
必須

ウォレットでの操作後にユーザーのブラウザが戻るhttps URLで、request_idとresultが付加されます。このURLのホストは、アプリケーションのallowed_return_hostsに登録されている必要があります(またはアプリケーションのホワイトラベルドメインであること)。resultだけを信用しないでください。結果はGET .../verifications/{request_id}/またはWebhookで取得してください。

Required string length: 1 - 2048
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
country
enum<string>
デフォルト:GBR

OneID IDの国を示すISO 3166-1 alpha-3コード。デフォルトはGBRで、OneIDが対応する唯一の国です。

  • GBR - GBR
利用可能なオプション:
GBR
device
enum<string>
デフォルト:same_device

ユーザーがお客様のページを表示しているデバイスでサインインする場合はsame_device、別のデバイスを使用する場合(例:BankIDのQRコード)はcross_device。

  • same_device - same_device
  • cross_device - cross_device
利用可能なオプション:
same_device,
cross_device

レスポンス

すべてのウォレットエンドポイントが返す形式の、単独のウォレット検証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日