IDnow 核验会话数据 API

IDnow GmbH · 身份

IDnow Online Ident 是慕尼黑身份核验公司 IDnow GmbH 的品牌 Android 核验客户端，引导用户完成银行、电信或保险公司的 KYC 会话。依赖方签发 ident 码后，用户在起始屏输入该码，随后可加入与人工坐席的实时视频通话（VideoIdent / LiveSwitch）、用 AutoIdent 拍摄护照或身份证、通过 NFC 读取德国电子身份证芯片、复用已存储身份，或以合格电子签名签署 PDF 合同。9.7.16 版本从启动屏进入，经 ident 码起始屏、视频直播间、德国电子身份证芯片流程、已存储身份复用，最后在结果屏跳回发起核验的银行或电信商。应用需要摄像头、麦克风与 NFC，与 WebID、德国邮政 POSTIDENT 以及 Veriff 同属面向德国 BaFin 监管开户场景的视频核验 / 电子身份证方案。

核验会话令牌在客户记录上以 token 出现，把依赖方案件绑到持有人的 firstName、lastName、email、mobile 以及实时 status。记录用 processType 标明通道，保留 preferredLang，并嵌套视频排队：clientSecret、sessionToken、positionInQueue、estimatedWaitingTime 与 userVideoSessionToken。启动载荷加上所选 idType / idCountry 以及 os、sdkVersion、customerapp。图像分类以 country、idType、idSubtype 对照 PASSPORT / IDCARD / DRIVERS_LICENSE / RESIDENCE_PERMIT 返回；OTP 证明是 confirmationToken；录制同意是 consentValue。静帧按面标记 IDFRONTSIDE、IDBACKSIDE、FACE；活体为 FACESCREENSHOT；片段带 encoding H264。通话内聊天存成 text / originator；通话前探测在 user.video / user.audio 下报告每路 quality。

德国电子身份证芯片会话给出 tcTokenUrl、mobileToken 与 eID 的 sessionToken，modelEnableOTP 把 ident 与 signing 分开。NFC 读芯后上报 resultToken 与 internalToken；界面由 request_step 推进。合同 PDF 以 hash、displayHash 和 documentDefinition（identifier、optional）到达；InstantSign 再给出 Identification_Signature。钱包复用是 authenticatedRequest 与 expiredWalletExists；高并发日翻转 waitingListEnrolled / waitingListNotified；通话后质量是 rating 与 reason。跳转使用租户 sucessUrl / failureUrl（成功键在线路上就是这种拼写）。租户产能是 officeOpen、numberOfWaitingChatRequests 以及 officeHours 行（days、hours）；口述确认句以 translationKey 加 value 到达。

银行与电信 KYC 台可在开户前跟踪队列位置与流程类型；合规引擎可强制签发国与证件族白名单；nPA 栈可用电子身份证令牌 URL 驱动 NFC 芯片流程；信贷与合格电子签名台可将 PDF 哈希与 InstantSign 签名对账。openData Studio 把这套核验会话数据变成可直接调用的开放数据，服务上述集成。

应用截图

API 端点一览

以下端点与请求/响应示例均依据应用界面推导重构，为示意说明，并非实际抓包。

获取核验会话
GET /v1/idnow/cases/{caseId} osint
以 Models_Customer 返回核验案件：持有人姓名与联系方式、processType、实时 status，以及嵌套的视频排队 request（clientSecret、sessionToken、positionInQueue）和成功/失败跳转 URL。
认证方式：路径参数 tenantId 与 caseId。请求头 Accept、X-Client-Version、X-Client-SDK-Version；start 之后可选 X-Client-Secret。
- token
- internalToken
- status
- email
- mobile
- firstName
- lastName
- preferredLang
- processType
- redirectUrl
- remainingInternalTokenRetries
- preEstablishVideoConnection
- waitingListEnrolled
- waitingListNotified
- custom1
- videoSession
- userVideoSessionToken
- videoserverUsed
- clientSecret
- sessionToken
- estimatedWaitingTime
- positionInQueue
- Identification_Signature
- sucessUrl
- failureUrl
```
GET /v1/idnow/cases/TST-AAAAA HTTP/1.1
Accept: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
```
```
{
  "token": "TST-AAAAA",
  "internalToken": "int-9f2c1a",
  "status": "PENDING",
  "email": "[email protected]",
  "mobile": "+491701234567",
  "firstName": "Anna",
  "lastName": "Mueller",
  "preferredLang": "de",
  "processType": "VIDEO_IDENT",
  "redirectUrl": "https://bank.example.de/ident/done",
  "request": {
    "status": "REQUESTED_CHAT",
    "clientSecret": "cs_7e91",
    "sessionToken": "st_4d21",
    "estimatedWaitingTime": 120,
    "positionInQueue": 3
  },
  "settings": {
    "sucessUrl": "https://bank.example.de/ident/ok",
    "failureUrl": "https://bank.example.de/ident/fail"
  }
}
```

启动核验

POST /v1/idnow/cases/{caseId}/start osint

用持有人联系方式、所选 idType/idCountry 与设备 clientInfo 启动核验案件；返回 status、OTP 开关、嵌套 data 以及产生 clientSecret 的视频排队 request。

认证方式：路径参数 tenantId 与 caseId。同样的客户端版本头。JSON 体含持有人联系方式、idType/idCountry 与 clientInfo。

token
mobile
email
preferredLang
authenticatedRequest
idType
idCountry
type
consentProtocolVersion
language
locale
os
sdkVersion
customerapp
status
remainingInternalTokenRetries
ident
signing
originator
timestamp
clientSecret
sessionToken
estimatedWaitingTime
positionInQueue
userVideoSessionToken
videoserverUsed

POST /v1/idnow/cases/TST-AAAAA/start HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "token": "TST-AAAAA",
  "mobile": "+491701234567",
  "email": "[email protected]",
  "preferredLang": "de",
  "data": {"idType": "IDCARD", "idCountry": "DE", "type": "IDENT"},
  "clientInfo": {"os": "Android", "sdkVersion": "9.7.16", "customerapp": "orangeapp"}
}

{
  "token": "TST-AAAAA",
  "status": "STARTED",
  "remainingInternalTokenRetries": 3,
  "enableOTP": {"ident": true, "signing": false},
  "data": {"idType": "IDCARD", "idCountry": "DE", "originator": "acmebank"},
  "request": {
    "clientSecret": "cs_7e91",
    "sessionToken": "st_4d21",
    "estimatedWaitingTime": 90,
    "positionInQueue": 2
  }
}

获取租户办公时段

GET /v1/idnow/tenants/{tenantId}/hours opendata

返回租户的 Models_OfficeHours：坐席台是否 officeOpen、排队人数、estimatedWaitingTime、可说 availableLanguages 以及按星期的 officeHours 行（days、hours）。

认证方式：路径参数 tenantId。请求头 Accept、X-Client-Version、X-Client-SDK-Version。

shortname
shortcode
name
officeOpen
estimatedWaitingTime
numberOfWaitingChatRequests
highCallVolumeMessage
waitingListNotified
availableLanguages
days
hours

GET /v1/idnow/tenants/acmebank/hours HTTP/1.1
Accept: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "shortname": "acmebank",
  "shortcode": "ACM",
  "name": "Acme Bank Ident",
  "officeOpen": true,
  "estimatedWaitingTime": 180,
  "numberOfWaitingChatRequests": 12,
  "highCallVolumeMessage": "High demand — please wait",
  "waitingListNotified": false,
  "availableLanguages": ["de", "en"],
  "company": { "name": "Acme Bank AG" },
  "officeHours": [
    { "days": "Mon-Fri", "hours": "08:00-20:00" },
    { "days": "Sat", "hours": "09:00-14:00" }
  ]
}

列出电子签名 PDF 文档

GET /v1/idnow/cases/{caseId}/contracts openfinance

以 Models_PDFDocument 行返回挂在核验案件上的 PDF 合同，含内容 hash、displayHash 以及供电子签名审阅屏使用的 documentDefinition（identifier、optional）。

认证方式：路径参数 tenantId 与 caseId。同样的客户端版本头；start 返回 clientSecret 时带 X-Client-Secret。

name
status
version
hash
displayHash
identifier
optional

GET /v1/idnow/cases/TST-AAAAA/contracts HTTP/1.1
Accept: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
X-Client-Secret: cs_7e91

[
  {
    "name": "loan-agreement.pdf",
    "status": "PENDING",
    "version": "1",
    "hash": "e3b0c44298fc1c149afbf4c8996fb924",
    "displayHash": "E3B0-C442",
    "documentDefinition": {
      "identifier": "LOAN_AGREEMENT",
      "name": "Loan agreement",
      "optional": false
    }
  }
]

列出口述确认短语

GET /v1/idnow/cases/{caseId}/spoken-phrases opendata

返回坐席要求持有人朗读的 Models_ApprovalPhrase 行，含 translationKey、口述 value 以及可选 urls（link、label、action）。

认证方式：路径参数 tenantId 与 caseId，加上客户端版本头。

name
translationKey
value
link
label
action

GET /v1/idnow/cases/TST-AAAAA/spoken-phrases HTTP/1.1
Accept: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

[
  {
    "name": "recording_consent",
    "translationKey": "idnow.phrase.recording",
    "value": "I agree that this identification is recorded",
    "urls": {
      "privacy": {
        "link": "https://bank.example.de/privacy",
        "label": "Privacy notice",
        "translationKey": "idnow.link.privacy",
        "action": "OPEN"
      }
    }
  }
]

上传证件分类信息

POST /v1/idnow/cases/{caseId}/document-meta osint

在拍图前登记用户所选证件：签发国 idCountry、idType（IDCARD/PASSPORT/DRIVERS_LICENSE/RESIDENCE_PERMIT）以及 idSubtype。

认证方式：路径参数 tenantId 与 caseId。JSON 体含 idCountry、idType 与 idSubtype。

idCountry
idType
idSubtype

POST /v1/idnow/cases/TST-AAAAA/document-meta HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "idCountry": "DE",
  "idType": "IDCARD",
  "idSubtype": "NATIONAL_ID"
}

{
  "idCountry": "DE",
  "idType": "IDCARD",
  "idSubtype": "NATIONAL_ID"
}

对拍摄的证件图分类

POST /v1/idnow/cases/{caseId}/document-class osint

上传已拍摄的证件图，返回带检测到的 country、idType 与 idSubtype 的 Model_Classification，供 AutoIdent 锁定证件族。

认证方式：路径参数 tenantId 与 caseId。Multipart 图像体加客户端版本头。

country
idType
idSubtype

POST /v1/idnow/cases/TST-AAAAA/document-class HTTP/1.1
Accept: application/json
Content-Type: multipart/form-data; boundary=----idnow
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

------idnow
Content-Disposition: form-data; name="file"; filename="front.jpg"
Content-Type: image/jpeg

(binary)
------idnow--

{
  "country": "DE",
  "idType": "IDCARD",
  "idSubtype": "NATIONAL_ID"
}

上传拍摄的证件图
POST /v1/idnow/cases/{caseId}/stills/{side} osint
在 AutoIdent 分类之后，按路径 type（IDFRONTSIDE / IDBACKSIDE / DRIVERSFRONTSIDE / DRIVERSBACKSIDE / FACE）上传证件某一面或人脸静帧，供坐席或电子签名审阅使用。
认证方式：路径参数 tenantId、caseId 与 side（IDFRONTSIDE、IDBACKSIDE、DRIVERSFRONTSIDE、DRIVERSBACKSIDE、FACE）。Multipart 体。
- type
```
POST /v1/idnow/cases/TST-AAAAA/stills/IDFRONTSIDE HTTP/1.1
Accept: application/json
Content-Type: multipart/form-data; boundary=----idnow
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

------idnow
Content-Disposition: form-data; name="file"; filename="id-front.jpg"
Content-Type: image/jpeg

(binary)
------idnow--
```
```
{
  "type": "IDFRONTSIDE",
  "status": "UPLOADED"
}
```
上传人脸截图
POST /v1/idnow/cases/{caseId}/liveness/{kind} osint
上报 VideoIdent 期间拍摄的活体/人脸静帧（Models_Screenshot.screenshot，type 为 FACESCREENSHOT），供坐席与证件肖像比对。
认证方式：路径参数 tenantId、caseId 与 kind（FACESCREENSHOT）。JSON 截图载荷加 type。
- screenshot
- type
```
POST /v1/idnow/cases/TST-AAAAA/liveness/FACESCREENSHOT HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "screenshot": "(base64 jpeg)",
  "type": "FACESCREENSHOT"
}
```
```
{
  "type": "FACESCREENSHOT",
  "status": "UPLOADED"
}
```

上传核验证件视频

POST /v1/idnow/cases/{caseId}/clips/{codec} osint

按编码标签 encoding（H264）上传 AutoIdent / VideoIdent 拍摄片段，供坐席或分类器审阅动作证据。

认证方式：路径参数 tenantId、caseId 与 codec（H264）。Multipart 视频体加客户端版本头。

encoding

POST /v1/idnow/cases/TST-AAAAA/clips/H264 HTTP/1.1
Accept: application/json
Content-Type: multipart/form-data; boundary=----idnow
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

------idnow
Content-Disposition: form-data; name="file"; filename="ident.mp4"
Content-Type: video/mp4

(binary)
------idnow--

{
  "encoding": "H264",
  "status": "UPLOADED"
}

提交录制同意
POST /v1/idnow/cases/{caseId}/recording-consent opendata
在 VideoIdent 坐席通话前上报用户的录制同意标志 consentValue，对应 showRecordingAgreement 配置。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 consentValue。
- consentValue
```
POST /v1/idnow/cases/TST-AAAAA/recording-consent HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "consentValue": true
}
```
发送手机确认令牌
POST /v1/idnow/cases/{caseId}/mobile-otp osint
在租户开启 verifyMobileNumber 时提交短信/OTP 的 confirmationToken，证明持有人控制核验案件上的手机号。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 confirmationToken。
- confirmationToken
```
POST /v1/idnow/cases/TST-AAAAA/mobile-otp HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "confirmationToken": "847291"
}
```
```
{
  "confirmationToken": "847291"
}
```
更新手机号
POST /v1/idnow/cases/{caseId}/mobile osint
用户在 OTP 或视频前更正号码时，把新的 E.164 mobile 写到核验案件上并回读已存储的 mobile。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 mobile。租户标志 disabledMobileNumberChange 可阻止该调用。
- mobile
```
POST /v1/idnow/cases/TST-AAAAA/mobile HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "mobile": "+491701234567"
}
```
```
{
  "mobile": "+491701234567"
}
```
检查钱包复用资格
GET /v1/idnow/cases/{caseId}/wallet-reuse osint
告知 StoredIdentityActivity 先前核验是否可复用（authenticatedRequest），以及是否仍存在过期钱包（expiredWalletExists）。
认证方式：路径参数 tenantId 与 caseId，加上客户端版本头。
- authenticatedRequest
- expiredWalletExists
```
GET /v1/idnow/cases/TST-AAAAA/wallet-reuse HTTP/1.1
Accept: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
```
```
{
  "authenticatedRequest": true,
  "expiredWalletExists": false
}
```

启动德国电子身份证会话

POST /v1/idnow/eid/{caseId}/open osint

打开德国电子身份证（nPA）芯片流程，返回 mobileToken、sessionToken 以及 eIDActivity 交给 NFC 栈（Authada）的 eID 服务器 tcTokenUrl。

认证方式：路径参数 tenantId 与 caseId。JSON 体含 eID clientInfo。

mobileToken
sessionToken
tcTokenUrl
modelEnableOTP
ident
signing
language
locale
os
sdkVersion
customerapp

POST /v1/idnow/eid/TST-AAAAA/open HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "clientInfo": {"language": "de", "os": "Android", "sdkVersion": "9.7.16"}
}

{
  "mobileToken": "mt_6c10",
  "sessionToken": "st_eID_9aa",
  "tcTokenUrl": "eid-token://handoff?session=st_eID_9aa",
  "modelEnableOTP": { "ident": true, "signing": true },
  "request": {
    "status": "RUNNING"
  }
}

登记高并发等候名单
POST /v1/idnow/cases/{caseId}/queue-join opendata
在高通话量时把核验案件登记到坐席等候名单（Activities_HighCallVolumeActivity）；后续客户拉取会回显 waitingListEnrolled / waitingListNotified。
认证方式：路径参数 tenantId 与 caseId。空 JSON 体。
- waitingListEnrolled
- waitingListNotified
```
POST /v1/idnow/cases/TST-AAAAA/queue-join HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{}
```
```
{}
```

订阅等候名单推送

POST /v1/idnow/cases/{caseId}/queue-push opendata

登记设备 FCM 的 subscriptionToken，使 Activities_HighCallVolumeActivity 能在坐席空位出现时通知持有人（type、appName）。

认证方式：路径参数 tenantId 与 caseId。JSON 体含 type、appName 与 subscriptionToken。

type
appName
subscriptionToken

POST /v1/idnow/cases/TST-AAAAA/queue-push HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "type": "FCM",
  "appName": "orangeapp",
  "subscriptionToken": "fcm-token-88ab"
}

{
  "type": "FCM",
  "appName": "orangeapp",
  "subscriptionToken": "fcm-token-88ab"
}

提交坐席评价
POST /v1/idnow/cases/{caseId}/agent-rating opendata
VideoIdent 会话结束后，从 Activities_AgentFeedbackActivity 上报坐席评分 rating 与自由文本 reason。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 rating 与 reason。受 enableAgentFeedback 控制。
- rating
- reason
```
POST /v1/idnow/cases/TST-AAAAA/agent-rating HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "rating": 5,
  "reason": "clear instructions"
}
```
请求视频通话
POST /v1/idnow/cases/{caseId}/video-room opendata
向核验台请求打开 LiveSwitch / VideoIdent 房间；成功日志为 requestVideoChat rest call was successful，后续客户拉取会回显 Models_Request 排队字段。
认证方式：路径参数 tenantId 与 caseId，加上客户端版本头。
- status
- videoSession
- userVideoSessionToken
- videoserverUsed
- clientSecret
- sessionToken
- estimatedWaitingTime
- positionInQueue
```
POST /v1/idnow/cases/TST-AAAAA/video-room HTTP/1.1
Accept: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
```
```
{
  "status": "REQUESTED_CHAT",
  "videoSession": "vs-88c1",
  "userVideoSessionToken": "uvt-22ab",
  "videoserverUsed": "eu-west-relay",
  "clientSecret": "cs_7e91",
  "sessionToken": "st_4d21",
  "estimatedWaitingTime": 90,
  "positionInQueue": 2
}
```

发送通话内坐席聊天

POST /v1/idnow/cases/{caseId}/agent-chat opendata

在 IDnowSDK.enableChat 开启时，上报 LiveSwitch 通话内聊天行（Models_TextMessage.content），视频房间以 Models_ChatMessage（text、date、originator、name）存储。

认证方式：路径参数 tenantId 与 caseId。JSON 体含 content。

content
text
date
originator
name

POST /v1/idnow/cases/TST-AAAAA/agent-chat HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "content": "Please hold your ID closer to the camera"
}

{
  "text": "Please hold your ID closer to the camera",
  "date": "2026-10-12T08:16:02Z",
  "originator": "AGENT",
  "name": "Mara"
}

启动通话质量检测
POST /v1/idnow/cases/{caseId}/call-probe opendata
用 sessionId 与 userVideoSessionToken 启动 CallQualityCheckActivity 的通话前探测；指标落入 CallQualityMetrics.user，视频与音频各有 CallStreamQuality.quality，再进入坐席房间。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 sessionId 与 userVideoSessionToken。
- sessionId
- userVideoSessionToken
- user
- video
- audio
- quality
```
POST /v1/idnow/cases/TST-AAAAA/call-probe HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "sessionId": "vs-88c1",
  "userVideoSessionToken": "uvt-22ab"
}
```
```
{
  "sessionId": "vs-88c1",
  "userVideoSessionToken": "uvt-22ab",
  "user": {
    "video": { "quality": 4 },
    "audio": { "quality": 5 }
  }
}
```
启动 InstantSign / 合格电子签名会话
POST /v1/idnow/qes/{caseId}/open openfinance
启动可信原件 / InstantSign 合格电子签名流程，返回 Identification_Signature、签名用 clientSecret/sessionToken 以及电子签名屏使用的 OTP 开关。
认证方式：路径参数 tenantId 与 caseId。JSON 体含持有人联系方式；响应带 Identification_Signature。
- Identification_Signature
- clientSecret
- sessionToken
- ident
- signing
- token
- email
- mobile
- preferredLang
```
POST /v1/idnow/qes/TST-AAAAA/open HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "token": "TST-AAAAA",
  "email": "[email protected]",
  "mobile": "+491701234567",
  "preferredLang": "de"
}
```
```
{
  "Identification_Signature": "qes-sess-4412",
  "clientSecret": "cs_sign_91",
  "sessionToken": "st_sign_02",
  "enableOTP": { "ident": false, "signing": true }
}
```

登记电子签名账户

POST /v1/idnow/cases/{caseId}/sign-account openfinance

在 signingDone 之前，用持有人的 email 与 mobile（Models_RegistrationeSign）为核验案件创建可信服务电子签名账户。

认证方式：路径参数 tenantId 与 caseId。JSON 体含 email 与 mobile。

email
mobile

POST /v1/idnow/cases/TST-AAAAA/sign-account HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "email": "[email protected]",
  "mobile": "+491701234567"
}

{
  "email": "[email protected]",
  "mobile": "+491701234567"
}

上报核验失败原因
POST /v1/idnow/cases/{caseId}/fail osint
核验无法完成时上报终态 failedReason 代码（例如 InstantSign 的 USER_ID_DOCUMENT_EXPIRED_NO_FALLBACK）。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 failedReason。
- failedReason
```
POST /v1/idnow/cases/TST-AAAAA/fail HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "failedReason": "USER_ID_DOCUMENT_EXPIRED_NO_FALLBACK"
}
```
标记核验已取消
POST /v1/idnow/cases/{caseId}/abort osint
告知核验案件持有人已中止，空 JSON 体与 IDnowCancelationStep 值（CONSENT、WAITING_LIST、AGENT_CONVERSATION、DOCUMENT_CLASSIFICATION）配对，供 Activities_ResultActivity 使用。
认证方式：路径参数 tenantId 与 caseId。空 JSON 体；结果屏展示持有人离开的取消步骤。
- resultCancelationStep
```
POST /v1/idnow/cases/TST-AAAAA/abort HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{}
```
```
{}
```
准备电子签名会话
POST /v1/idnow/cases/{caseId}/sign-prepare openfinance
在已有可信服务账户的核验案件上打开合格电子签名会话，使 SignContractView / CompleteEsignView 能在持有人审阅 PDF 前绑定 Identification_Signature、clientSecret 与 sessionToken。
认证方式：路径参数 tenantId 与 caseId。空 JSON 体；InstantSign 下发的 X-Client-Secret 可选。
- Identification_Signature
- clientSecret
- sessionToken
```
POST /v1/idnow/cases/TST-AAAAA/sign-prepare HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
X-Client-Secret: cs_sign_91

{}
```
```
{}
```
完成电子签名 / 合格电子签名
POST /v1/idnow/cases/{caseId}/sign-complete openfinance
持有人接受带哈希的 PDF 后把合格电子签名 / InstantSign 流程标为完成；CompleteEsignView 将 Identification_Signature 视为终态，Activities_ResultActivity 可跟随 sucessUrl。
认证方式：路径参数 tenantId 与 caseId。空 JSON 体；InstantSign 下发的 X-Client-Secret 可选。
- status
- Identification_Signature
```
POST /v1/idnow/cases/TST-AAAAA/sign-complete HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
X-Client-Secret: cs_sign_91

{}
```
```
{}
```
拒绝电子签名文档
POST /v1/idnow/cases/{caseId}/sign-refuse openfinance
记录持有人在 SignContractView 拒绝所附 PDF 合同、未完成合格电子签名，核验案件不以 Identification_Signature 结束。
认证方式：路径参数 tenantId 与 caseId。空 JSON 体。
- status
```
POST /v1/idnow/cases/TST-AAAAA/sign-refuse HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{}
```
```
{}
```
获取可信服务 PDF
GET /v1/idnow/cases/{caseId}/tsp-pdf openfinance
下载该核验案件的可信服务提供商（TSP）PDF，供 Activities_PDFViewer 展示与 documents 列表中 hash / displayHash / documentDefinition.identifier 对应的同一文档。
认证方式：路径参数 tenantId 与 caseId。Accept application/pdf；X-Client-Secret 可选。原始 PDF 体。
- hash
- displayHash
- identifier
- name
```
GET /v1/idnow/cases/TST-AAAAA/tsp-pdf HTTP/1.1
Accept: application/pdf
X-Client-Version: .android-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16
X-Client-Secret: cs_sign_91
```
```
(binary PDF; Activities_PDFViewer / PDFWebView render the trust-service provider document whose hash matches Models_PDFDocument.hash)
```
提交德国电子身份证结果令牌
POST /v1/idnow/eid/chip-result osint
把 nPA 读芯得到的 resultToken 连同 eID 的 sessionToken 与核验 internalToken 上报，供 eIDActivity 结束 Authada / AusweisApp2Service 交接。
认证方式：路径参数 tenantId。NFC 读芯后的 JSON 体含 resultToken、sessionToken 与 internalToken。
- resultToken
- sessionToken
- internalToken
```
POST /v1/idnow/eid/chip-result HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-eid-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "resultToken": "rt_aa19",
  "sessionToken": "st_eID_9aa",
  "internalToken": "int-9f2c1a"
}
```
推进德国电子身份证步骤
POST /v1/idnow/eid/{caseId}/step osint
通过上报 request_step，把电子身份证会话推到 eIDActivity 内的下一 NFC / PIN / CAN 界面（eID 客户端为空时会跳过该 REST）。
认证方式：路径参数 tenantId 与 caseId。JSON 体含 request_step。
- request_step
```
POST /v1/idnow/eid/TST-AAAAA/step HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Client-Version: .android-eid-9.7.16
X-Client-SDK-Version: orangeapp.androidsdk-9.7.16

{
  "request_step": "READ_CHIP"
}
```
```
{}
```

数据类别

核验会话
身份证件类型
德国电子身份证
合格电子签名
坐席等候队列
租户办公时段
拍摄的证件图
视频聊天

数据使用场景与案例

银行 KYC 案件跟踪
BaFin 开户台可轮询 token、status、processType、firstName、lastName 以及嵌套的 positionInQueue / estimatedWaitingTime，判断 VideoIdent 案件仍在排队、已进坐席房间，或可通过 sucessUrl 跳转。
证件族白名单
合规引擎可消费分类与证件信息记录中的 idCountry、idType、idSubtype（PASSPORT、IDCARD、DRIVERS_LICENSE、RESIDENCE_PERMIT），强制产品只接受特定签发国与证件族。
德国电子身份证芯片交接
nPA / 电子身份证栈可从 eID 启动记录取出 tcTokenUrl、mobileToken 与 sessionToken 驱动 NFC AusweisApp 流程，再用 modelEnableOTP.ident / signing 控制 OTP。
合格电子签名合同哈希对账
信贷或电信电子签名台可将 PDF 的 hash、displayHash 与 documentDefinition.identifier 比对，再把 InstantSign 的 Identification_Signature 与签名 clientSecret 绑到同一 ident token。

常见问题

哪些字段标识一次 IDnow Online Ident 会话？

客户记录以 token 和 internalToken 作为案件键，并携带 status、processType、firstName、lastName、email、mobile，以及含 clientSecret、sessionToken、positionInQueue 的嵌套 request。

身份证件类型如何表示？

分类与证件信息记录使用 idCountry / country、idType 与 idSubtype。证件类型枚举为 PASSPORT、IDCARD、DRIVERS_LICENSE 与 RESIDENCE_PERMIT。

德国电子身份证启动响应包含什么？

返回供 NFC / AusweisApp 交接的 mobileToken、sessionToken 与 tcTokenUrl，以及把 ident 与 signing 分开的 modelEnableOTP 开关。读芯后把 resultToken 连同 sessionToken 与 internalToken 上报。

电子签名 PDF 合同如何描述？

每份文档含 name、status、version、hash、displayHash，以及带 identifier、name、optional 的 documentDefinition。InstantSign 另给 Identification_Signature、clientSecret 与 sessionToken。

与 IDnow Online Ident 相似的应用

POSTIDENT — 德国邮政 POSTIDENT 可在邮局、视频通话、电子身份证、自动 AutoID 或上门投递时核验身份，常用于开户或 SIM 卡激活。
WebID — WebID Solutions 为银行与保险公司提供 KYC，包括 VideoID 实时通话、自动 AutoID、德国电子身份证与 NFC ePassID、可复用 TrueID，以及 SignID 合格签名。
Veriff — Veriff 通过证件核验、人脸比对与活体检测确认本人，并提供反洗钱筛查与企业核验。
Jumio — Jumio 结合政府证件核验、带活体检测的自拍和风险判定，自动完成 KYC 与反洗钱开户中的身份核验。
Nect Ident — Nect Ident 是德国身份核验产品，支持证件扫描加自拍的 Auto Video Ident、NFC 电子身份证、ePass 芯片读取，以及 Nect Wallet 复用的 ReIdent。
AUTHADA — AUTHADA ident 让用户用智能手机读取德国电子身份证芯片完成线上核验，同一厂商还提供电子签署与现场 KYC。
Onfido — Onfido 是伦敦的身份核验公司，用政府证件照片与自拍比对以确认本人。
Sumsub Video Identification — Sumsub Video Identification 是远程 KYC 面谈：合规坐席在实时视频中把用户本人与其身份证件对照确认。

需要集成这个 App 的数据 API？

我们可为任意指定 App 交付定制集成——源码交付 USD 500 起，或托管 API 按调用计费。告诉我们您需要的数据即可。

每个项目均签 NDA 与 SOW
3–7 天交付
验收通过后才付款
仅在授权范围内作业

获取报价

IDnow 核验会话数据 API

应用截图

API 端点一览

获取核验会话

启动核验

获取租户办公时段

列出电子签名 PDF 文档

列出口述确认短语

上传证件分类信息

对拍摄的证件图分类

上传拍摄的证件图

上传人脸截图

上传核验证件视频

提交录制同意

发送手机确认令牌

更新手机号

检查钱包复用资格

启动德国电子身份证会话

登记高并发等候名单

订阅等候名单推送

提交坐席评价

请求视频通话

发送通话内坐席聊天

启动通话质量检测

启动 InstantSign / 合格电子签名会话

登记电子签名账户

上报核验失败原因

标记核验已取消

准备电子签名会话

完成电子签名 / 合格电子签名

拒绝电子签名文档

获取可信服务 PDF

提交德国电子身份证结果令牌

推进德国电子身份证步骤

数据类别

数据使用场景与案例

银行 KYC 案件跟踪

证件族白名单

德国电子身份证芯片交接

合格电子签名合同哈希对账

常见问题

相关应用

与 IDnow Online Ident 相似的应用

更多身份类应用

Duo Mobile

GOSI

Microsoft Authenticator

Pak Identity

相关主题

需要集成这个 App 的数据 API？