跳转到主要内容
POST
cURL
Starten Sie die Personalausweis-Profile-2-Verifizierung von Ihrem Backend aus mit Ihrem Anwendungs-API-Schlüssel. Sie benötigen weder einen Workflow noch eine workflow_id. Die Antwort auf den Start beschreibt die nächste Authentifizierungsaktion; sie ist kein bestätigtes Identitätsergebnis.

Abdeckung und Aktivierung

Die Aktivierung eines Wallets ist unabhängig von der API-Bereitstellung und der Berechtigung Ihrer Anwendung. Ein dokumentierter Endpunkt aktiviert kein Wallet, das als Demnächst verfügbar gekennzeichnet ist. Die aktuellen veröffentlichten Preise finden Sie unter Preise für digitale ID-Wallets.

Was die Person tut

Folgen Sie der nächsten Aktion, die die Startanfrage zurückgibt. Die Authentifizierungsoberfläche des Wallets bestimmt, ob die Person einen Browser, ein anderes Gerät oder eine App verwendet.

Ergebnis abrufen

Folgen Sie dem Leitfaden zur Digital-ID-Wallet-API, um die Verifizierung zu verfolgen und ihr Ergebnis abzurufen. Betrachten Sie nur ein abgeschlossenes, verifiziertes Ergebnis als Nachweis, dass das Wallet die Person authentifiziert hat. Die zurückgegebenen Identitätsattribute variieren je nach Wallet; gehen Sie nicht davon aus, dass eine Adresse, ein Porträt oder alle angefragten Attribute vorhanden sind.

Verwandte Seiten

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

请求头

Idempotency-Key
string

可选的重试安全密钥(最多 255 个字符)。使用相同的密钥、钱包和请求体进行重试将返回原始验证结果,而不会发起第二次登录;若将相同密钥用于其他钱包或请求体,则返回 409 idempotency_key_reused。

请求体

发起 Personalausweis 验证(DEU)。

return_url
string<uri>
必填

用户浏览器在钱包操作后返回的 https URL,末尾会附加 request_id 和 result。其 host 必须在应用的 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>
默认值:DEU

Personalausweis 身份的 ISO 3166-1 alpha-3 国家/地区。默认为 DEU,即其支持的唯一国家/地区。

  • DEU - DEU
可用选项:
DEU
device
enum<string>
默认值:same_device

用户在显示您页面的设备上登录时为 same_device,使用另一台设备(例如 BankID 二维码)时为 cross_device。

  • same_device - same_device
  • cross_device - cross_device
可用选项:
same_device,
cross_device

响应

单次独立钱包验证,正如每个钱包 endpoint 返回的结果一样。

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

启动时发送的元数据对象,或 null。

created_at
string<date-time>
必填
最后修改于 2026年11月7日