@sekyro/web 0.1.0-rc.24 → 0.1.0-rc.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +32 -2
- package/dist/{capture-session-doc-RIBBH3M4.js → capture-session-doc-WZMI5XPE.js} +1 -1
- package/dist/{capture-session-v3-CPHzDT7E.d.cts → capture-session-v3-BKSjJ6L0.d.cts} +1 -1
- package/dist/{capture-session-v3-TUPtnvmu.d.ts → capture-session-v3-C1I_GLC9.d.ts} +1 -1
- package/dist/challenge-frame-NUGPTWFP.js +1 -0
- package/dist/{chunk-MXWLCDFX.js → chunk-4DEPREJ3.js} +1 -1
- package/dist/{chunk-LBH6KGTV.js → chunk-65JZHKVG.js} +1 -1
- package/dist/{chunk-FLA42JCK.js → chunk-7MZW3FFH.js} +1 -1
- package/dist/chunk-DVTK2DGX.js +1 -0
- package/dist/chunk-GPFAPAS6.js +3 -0
- package/dist/chunk-HVW2AB35.js +1 -0
- package/dist/{chunk-IFLOS5OT.js → chunk-LLX2CKZ3.js} +1 -1
- package/dist/chunk-LV23FCYP.js +1 -0
- package/dist/{chunk-TDLIXFDT.js → chunk-NFHLJOHW.js} +1 -1
- package/dist/{chunk-5YVQIHQA.js → chunk-OVP7FAMJ.js} +1 -1
- package/dist/{chunk-XI5FXEKC.js → chunk-XOTKATN6.js} +1 -1
- package/dist/chunk-ZCW6PNUX.js +1 -0
- package/dist/client/index.cjs +1 -1
- package/dist/client/index.d.cts +3 -3
- package/dist/client/index.d.ts +3 -3
- package/dist/client/index.js +1 -1
- package/dist/core/index.cjs +1 -1
- package/dist/core/index.d.cts +3 -3
- package/dist/core/index.d.ts +3 -3
- package/dist/core/index.js +1 -1
- package/dist/create-document-capture-OXPLKHOF.js +1 -0
- package/dist/{create-verification-acQzNRiB.d.ts → create-verification-7wPXJN_P.d.ts} +287 -120
- package/dist/{create-verification-DF60lg8Y.d.cts → create-verification-YeuI7_B0.d.cts} +287 -120
- package/dist/{detector-scanic-YCDNLCGV.js → detector-scanic-23DAYT3H.js} +1 -1
- package/dist/{icao-gate-CX0chQMM.d.cts → icao-gate-BK8TGaCk.d.ts} +1 -1
- package/dist/{icao-gate-VwsQo8Bq.d.ts → icao-gate-pD2dUV3P.d.cts} +1 -1
- package/dist/{icao-policy-WnG2OSyp.d.cts → icao-policy-CdR6PFHS.d.cts} +2 -2
- package/dist/{icao-policy-B02jDiox.d.ts → icao-policy-qJpZOOOu.d.ts} +2 -2
- package/dist/index.cjs +3 -1
- package/dist/index.d.cts +9 -9
- package/dist/index.d.ts +9 -9
- package/dist/index.js +1 -1
- package/dist/internal/index.cjs +3 -1
- package/dist/internal/index.d.cts +69 -114
- package/dist/internal/index.d.ts +69 -114
- package/dist/internal/index.js +1 -1
- package/dist/plan-runner-EP26JU6A.js +1 -0
- package/dist/{types-1s8CQrEN.d.ts → types-DB-cZTSn.d.cts} +156 -29
- package/dist/{types-1s8CQrEN.d.cts → types-DB-cZTSn.d.ts} +156 -29
- package/dist/upload-file-EGXXM6TQ.js +1 -0
- package/package.json +1 -1
- package/sbom.cdx.json +10 -10
- package/dist/chunk-DMOGKGDS.js +0 -1
- package/dist/chunk-IC6TI6GV.js +0 -1
- package/dist/chunk-MQBX4DQQ.js +0 -1
- package/dist/chunk-QY6TJCOJ.js +0 -1
- package/dist/chunk-TDCLQRT4.js +0 -1
- package/dist/create-document-capture-XQURFZZK.js +0 -1
- package/dist/plan-runner-LDV4PYN7.js +0 -1
- package/dist/turnstile-52B3RFXD.js +0 -1
- package/dist/upload-file-UYXOHCRG.js +0 -1
|
@@ -286,7 +286,9 @@ type CheckState = "pending" | "input_required" | "processing" | "passed" | "fail
|
|
|
286
286
|
* profile v2 §4.6.5) confirms an email address with a one-time code;
|
|
287
287
|
* `eid_auth` (SDK spec §3.2) is the national eID sign-in (Houwiyeti in MR).
|
|
288
288
|
*/
|
|
289
|
-
type CheckType = "liveness" | "face_match" | "doc_ocr" | "population_registry" | "phone_otp" | "nfc_chip" | "email_otp" | "portrait_icao" | "eid_auth"
|
|
289
|
+
type CheckType = "liveness" | "face_match" | "doc_ocr" | "population_registry" | "phone_otp" | "nfc_chip" | "email_otp" | "portrait_icao" | "eid_auth"
|
|
290
|
+
/** Spec 2026-11-10 §5: the proof of address step (a bill or statement, images or one PDF). */
|
|
291
|
+
| "poa";
|
|
290
292
|
type LivenessReason = "no_face" | "media_unreadable" | "clip_too_short" | "spoof_detected" | "review_band" | "liveness_inconclusive" | "device_integrity_failed" | "mobile_required" | "capture_back_camera" | "capture_not_upright" | "capture_front_camera" | "multiple_faces" | "camera_unavailable";
|
|
291
293
|
type PopulationReason = "registry_record_not_found" | "nni_not_found" | "id_number_invalid" | "nni_invalid" | "registry_unavailable" | "nationality_not_allowed" | "underage" | "age_unverifiable" | "name_mismatch" | "birth_date_mismatch" | "nationality_mismatch" | "id_number_recheck" | "nni_recheck";
|
|
292
294
|
type FaceMatchReason = "no_face_source" | "no_face_reference" | "low_quality_reference" | "below_threshold" | "review_band" | "match_inconclusive" | "subject_revoked" | "probe_not_from_liveness" | "prior_review_approved";
|
|
@@ -320,7 +322,7 @@ type PhoneOtpReason = "otp_mismatch" | "otp_expired" | "otp_send_failed" | "otp_
|
|
|
320
322
|
* mail (`email_invalid`), or a disposable address the app blocks
|
|
321
323
|
* (`email_disposable`) — the person enters another address or resends.
|
|
322
324
|
*/
|
|
323
|
-
type EmailOtpReason = "otp_mismatch" | "otp_expired" | "otp_send_failed" | "otp_rate_limited" | "otp_resend_limit" | "email_invalid" | "email_disposable" | "otp_daily_cap_reached";
|
|
325
|
+
type EmailOtpReason = "otp_mismatch" | "otp_expired" | "otp_send_failed" | "otp_rate_limited" | "otp_resend_limit" | "email_invalid" | "email_disposable" | "otp_daily_cap_reached" | "payment_method_required" | "spend_cap_reached" | "insufficient_balance" | "account_verification_required";
|
|
324
326
|
/**
|
|
325
327
|
* nfc_chip reasons (M-nfc, SDK spec §4.3). Native SDKs read the chip; the web
|
|
326
328
|
* never does — on web the step arrives `skipped` (`platform_unsupported`) or
|
|
@@ -347,12 +349,23 @@ type EidReason = "eid_identifier_invalid" | "eid_code_invalid" | "eid_code_expir
|
|
|
347
349
|
* is final and ends the session.
|
|
348
350
|
*/
|
|
349
351
|
type AgeEstimationReason = "age_uncertain" | "age_unavailable" | "underage_estimated";
|
|
352
|
+
/**
|
|
353
|
+
* Reasons of the proof of address step (`poa`, spec 2026-11-10 §5.3), in the server's decision order:
|
|
354
|
+
* `provider_unavailable` (the document could not be checked now; retry), `unreadable` (a sharper, complete copy),
|
|
355
|
+
* `pdf_protected` (the PDF has a password, scripts, attachments or forms), `document_kind_not_accepted` and
|
|
356
|
+
* `document_too_old` (the step's rule for the document's country says what is accepted: `proofOfAddress.rule`),
|
|
357
|
+
* `document_date_invalid` (a date in the future), `document_tampered` (final), `name_mismatch`,
|
|
358
|
+
* `holder_letter_required` (the bill is in another person's name: the step asks for the holder's letter,
|
|
359
|
+
* `proofOfAddress.phase: "holder_letter"`), `holder_letter_missing` (the letter is incomplete) and `address_mismatch`
|
|
360
|
+
* (the address differs from the one the partner supplied).
|
|
361
|
+
*/
|
|
362
|
+
type PoaReason = "provider_unavailable" | "unreadable" | "pdf_protected" | "document_kind_not_accepted" | "document_date_invalid" | "document_too_old" | "document_tampered" | "name_mismatch" | "holder_letter_required" | "holder_letter_missing" | "address_mismatch";
|
|
350
363
|
/**
|
|
351
364
|
* Any frozen reason code. The backend declares the field `string`, but the
|
|
352
365
|
* taxonomy is frozen (do-not-drift) — the union IS the contract. NB: liveness
|
|
353
366
|
* and face_match both carry `review_band`.
|
|
354
367
|
*/
|
|
355
|
-
type CheckReason = LivenessReason | PopulationReason | FaceMatchReason | DocReason | PhoneOtpReason | EmailOtpReason | NfcChipReason | PortraitIcaoReason | EidReason
|
|
368
|
+
type CheckReason = LivenessReason | PopulationReason | FaceMatchReason | DocReason | PhoneOtpReason | EmailOtpReason | NfcChipReason | PortraitIcaoReason | EidReason | PoaReason
|
|
356
369
|
/**
|
|
357
370
|
* Spec 2026-10-27 (Sandbox testers), tester-bound sessions only:
|
|
358
371
|
* `tester_document_mismatch` (doc_ocr, nfc_chip) when the document read is
|
|
@@ -402,8 +415,11 @@ type CameraUnavailableCause = "denied" | "no_camera";
|
|
|
402
415
|
* error's `name` (letters only, at most 40 characters).
|
|
403
416
|
*/
|
|
404
417
|
interface CaptureIssueReport {
|
|
405
|
-
/**
|
|
406
|
-
|
|
418
|
+
/**
|
|
419
|
+
* The step whose camera failed (`portrait`: the portrait step's own camera, 2026-11-05), or `attestation`: the
|
|
420
|
+
* challenge frame produced no token (`kind: 'unavailable'`, the `ChallengeErrorCode` in `engineKind`).
|
|
421
|
+
*/
|
|
422
|
+
check: "liveness" | "document" | "portrait" | "attestation";
|
|
407
423
|
/** The public capture error kind shown, or `unavailable` (the SDK reason then rides in `engineKind`). */
|
|
408
424
|
kind: "permission" | "notfound" | "inuse" | "insecure" | "unsupported" | "generic" | "unavailable";
|
|
409
425
|
name?: string;
|
|
@@ -444,10 +460,11 @@ interface NationalEidOption {
|
|
|
444
460
|
type EidAfterPass = "end" | "continue";
|
|
445
461
|
/**
|
|
446
462
|
* The section a step belongs to (flow model 2026-10-23, SDK spec §3.7): Step 1
|
|
447
|
-
* `contact`, Step 2 `identity`, Step 3 `live_photo
|
|
448
|
-
*
|
|
463
|
+
* `contact`, Step 2 `identity`, Step 3 `live_photo`; `documents` holds the proof
|
|
464
|
+
* of address (spec 2026-11-10). Open: a value this SDK does not know is kept as
|
|
465
|
+
* is, so a client still places the step.
|
|
449
466
|
*/
|
|
450
|
-
type StepSection = "contact" | "identity" | "live_photo" | "screening" | (string & {});
|
|
467
|
+
type StepSection = "contact" | "identity" | "live_photo" | "screening" | "documents" | (string & {});
|
|
451
468
|
/** A contact channel of a contact choice (`phone_otp` → `phone`, `email_otp` → `email`). */
|
|
452
469
|
type ContactChannel = "phone" | "email";
|
|
453
470
|
/**
|
|
@@ -595,8 +612,12 @@ interface MethodChoiceView {
|
|
|
595
612
|
*/
|
|
596
613
|
nationalEid?: NationalEidOption;
|
|
597
614
|
}
|
|
598
|
-
/**
|
|
599
|
-
type
|
|
615
|
+
/**
|
|
616
|
+
* A document type the backend reads (kyc-docs-v2 vocabulary; `carte_identite` = identity card of any issuer).
|
|
617
|
+
* `drivers_license` (spec 2026-11-10 §6): a driving licence, two faces, no MRZ, offered only when the flow lists it
|
|
618
|
+
* (`"*"` never includes it).
|
|
619
|
+
*/
|
|
620
|
+
type AcceptedDocumentType = "carte_identite" | "passport" | "residence_permit" | "drivers_license";
|
|
600
621
|
/**
|
|
601
622
|
* Accepted document types per issuing country (profile v2 §5.3a): an issuer
|
|
602
623
|
* uses `byIssuer[iso2] ?? default`; `"*"` = every type.
|
|
@@ -1131,6 +1152,13 @@ interface HostedIntegrity {
|
|
|
1131
1152
|
appAttest: true;
|
|
1132
1153
|
};
|
|
1133
1154
|
}
|
|
1155
|
+
/** `HostedSessionView.challenge`: where the browser obtains its attestation token (spec 2026-11-10 §4.3). */
|
|
1156
|
+
interface HostedChallengeView {
|
|
1157
|
+
/** The challenge frame (`<hosted origin>/challenge`, always the platform host, never a custom domain). */
|
|
1158
|
+
url: string;
|
|
1159
|
+
/** The Turnstile site key the frame renders. */
|
|
1160
|
+
siteKey: string;
|
|
1161
|
+
}
|
|
1134
1162
|
interface HostedSessionView {
|
|
1135
1163
|
sessionId: string;
|
|
1136
1164
|
status: SessionStatus;
|
|
@@ -1161,15 +1189,13 @@ interface HostedSessionView {
|
|
|
1161
1189
|
*/
|
|
1162
1190
|
sdkOrigin?: string | null;
|
|
1163
1191
|
/**
|
|
1164
|
-
*
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1167
|
-
*
|
|
1168
|
-
*
|
|
1169
|
-
* environments. `null` only on a Live deployment without Turnstile: the SDK
|
|
1170
|
-
* sends no token and the server decides.
|
|
1192
|
+
* The Sekyro challenge frame the browser asks for an attestation token before it submits `liveness` (spec
|
|
1193
|
+
* 2026-11-10 §4.3): the platform's Turnstile widget runs inside a hidden frame at `url`, so the host page needs
|
|
1194
|
+
* only `frame-src <origin of url>`. On a Sandbox session `siteKey` is Cloudflare's always-passing test key, so the
|
|
1195
|
+
* same code runs in both environments. `null` only on a Live deployment without Turnstile: the SDK sends no token
|
|
1196
|
+
* and the server decides.
|
|
1171
1197
|
*/
|
|
1172
|
-
|
|
1198
|
+
challenge: HostedChallengeView | null;
|
|
1173
1199
|
/**
|
|
1174
1200
|
* A Sandbox (test) session: the hosted page marks it as a test session.
|
|
1175
1201
|
* Optional: absent on an older backend.
|
|
@@ -1343,6 +1369,12 @@ interface HostedSessionView {
|
|
|
1343
1369
|
* with no upload offered (and on older APIs): `{ source: "camera", uploadOffered: false }`.
|
|
1344
1370
|
*/
|
|
1345
1371
|
documents?: HostedDocumentsView;
|
|
1372
|
+
/**
|
|
1373
|
+
* Spec 2026-11-10 §5.4, §7.4: the open proof of address step's settings (the accepted kinds for the best known
|
|
1374
|
+
* country, the name rule, the phase, the photo source, the upload limits). Present only while a `poa` step is open;
|
|
1375
|
+
* absent on older APIs.
|
|
1376
|
+
*/
|
|
1377
|
+
proofOfAddress?: HostedProofOfAddressView;
|
|
1346
1378
|
/**
|
|
1347
1379
|
* Spec 2026-10-29 D12: where the hosted completion screen sends the person (`returnUrl`, checked at session
|
|
1348
1380
|
* create against the app's web origins or native scheme) and the partner's opaque `state`. Never the result.
|
|
@@ -1416,12 +1448,13 @@ interface SessionView {
|
|
|
1416
1448
|
createdAt?: string;
|
|
1417
1449
|
}
|
|
1418
1450
|
/** Media class — selects size cap, MIME allowlist and promoted prefix (media.policy.ts). */
|
|
1419
|
-
type MediaKind = "image" | "clip";
|
|
1451
|
+
type MediaKind = "image" | "clip" | "document_file";
|
|
1420
1452
|
/**
|
|
1421
1453
|
* Body of `POST /sessions/:id/media`. `contentType`/`contentLength` are the
|
|
1422
1454
|
* exact values SIGNED into the presigned PUT — the PUT must send them verbatim.
|
|
1423
1455
|
* Allowlists (media.policy.ts): image → image/jpeg | image/png (5 MB cap);
|
|
1424
|
-
* clip → video/webm | video/mp4 (15 MB cap)
|
|
1456
|
+
* clip → video/webm | video/mp4 (15 MB cap); document_file → application/pdf (10 MB cap, the proof of address
|
|
1457
|
+
* step's upload only, spec 2026-11-10 §7.1). BARE types only — no `;codecs=` params.
|
|
1425
1458
|
*/
|
|
1426
1459
|
interface PresignRequest {
|
|
1427
1460
|
kind: MediaKind;
|
|
@@ -1476,18 +1509,16 @@ interface CompleteMediaResult {
|
|
|
1476
1509
|
}
|
|
1477
1510
|
/**
|
|
1478
1511
|
* Liveness attestation bag (attestation-verifier.service.ts). The web SDK sends
|
|
1479
|
-
* `{channel: 'hosted_web',
|
|
1480
|
-
* `
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1483
|
-
*
|
|
1512
|
+
* `{channel: 'hosted_web', turnstileToken}` in both environments, or
|
|
1513
|
+
* `{channel: 'hosted_web'}` when the challenge produced no token (the server's
|
|
1514
|
+
* attestation rules decide). The token comes from the Sekyro challenge frame
|
|
1515
|
+
* ({@link HostedChallengeView}) and is bound to the session and the page's
|
|
1516
|
+
* origin. Native SDKs use platform attestation.
|
|
1484
1517
|
*/
|
|
1485
1518
|
interface AttestationInput {
|
|
1486
1519
|
signature?: string;
|
|
1487
1520
|
channel?: "hosted_web";
|
|
1488
1521
|
turnstileToken?: string;
|
|
1489
|
-
/** The Turnstile site key the token was minted with (selects the verifying secret). */
|
|
1490
|
-
siteKey?: string;
|
|
1491
1522
|
}
|
|
1492
1523
|
/**
|
|
1493
1524
|
* liveness executor input: a promoted `clips/…` key + optional attestation.
|
|
@@ -1535,8 +1566,13 @@ interface LivenessCaptureInput {
|
|
|
1535
1566
|
cameraReadyMs?: number;
|
|
1536
1567
|
faceAcquireMs?: number;
|
|
1537
1568
|
captureMs?: number;
|
|
1538
|
-
/** Uploads settled → attestation token in hand (the
|
|
1569
|
+
/** Uploads settled → attestation token in hand (the challenge frame on the web), ms. */
|
|
1539
1570
|
attestationMs?: number;
|
|
1571
|
+
/**
|
|
1572
|
+
* Why the web challenge produced no token (a `ChallengeErrorCode`: `challenge_frame_blocked`, `timeout`, ...),
|
|
1573
|
+
* lower case, at most 32 characters. Absent when the token was obtained.
|
|
1574
|
+
*/
|
|
1575
|
+
attestationError?: string;
|
|
1540
1576
|
/** The camera the clip was filmed with (`environment` = back). */
|
|
1541
1577
|
facingMode?: 'user' | 'environment';
|
|
1542
1578
|
/**
|
|
@@ -1620,6 +1656,90 @@ interface HostedDocumentsView {
|
|
|
1620
1656
|
*/
|
|
1621
1657
|
uploadOffered: boolean;
|
|
1622
1658
|
}
|
|
1659
|
+
/** The document kinds a proof of address may be (spec §5.2). */
|
|
1660
|
+
type PoaKind = "utility_bill" | "telecom_bill" | "bank_statement" | "tax_notice" | "rental_agreement" | "government_certificate" | "insurance_statement";
|
|
1661
|
+
/**
|
|
1662
|
+
* How the name on the document is matched: `exact_person` (the person's own name), `family_name` (the same family
|
|
1663
|
+
* name), `third_party_letter` (another holder, with a signed letter from that holder).
|
|
1664
|
+
*/
|
|
1665
|
+
type PoaNameMatchMode = "exact_person" | "family_name" | "third_party_letter";
|
|
1666
|
+
/**
|
|
1667
|
+
* Where the step's rule came from: the flow's rule for the country (`flow_country`), the flow's default rule
|
|
1668
|
+
* (`flow_default`), Sekyro's preset for the country (`preset_country`) or the global preset (`preset_global`).
|
|
1669
|
+
*/
|
|
1670
|
+
type PoaRuleSource = "flow_country" | "flow_default" | "preset_country" | "preset_global";
|
|
1671
|
+
/** One accepted kind of the step's rule. */
|
|
1672
|
+
interface HostedPoaRuleKindView {
|
|
1673
|
+
kind: PoaKind;
|
|
1674
|
+
/** How old the document of this kind may be, in days. */
|
|
1675
|
+
maxAgeDays: number;
|
|
1676
|
+
/** ISO day: today minus `maxAgeDays`, computed by the server so every client says the same date. */
|
|
1677
|
+
earliestIssueDate: string;
|
|
1678
|
+
}
|
|
1679
|
+
/** The accepted documents the step shows (spec §5.4 "person-facing list"), resolved by the server. */
|
|
1680
|
+
interface HostedPoaRuleView {
|
|
1681
|
+
/** The country the rule was resolved for (ISO 3166-1 alpha-2); `null` = the global entry. */
|
|
1682
|
+
country: string | null;
|
|
1683
|
+
/**
|
|
1684
|
+
* How that country was chosen: the identity document's issuer, else the IP country, else global; after a
|
|
1685
|
+
* `document_kind_not_accepted` or `document_too_old` failure, the failed document's own country (`document`).
|
|
1686
|
+
*/
|
|
1687
|
+
countryFrom: "identity_document" | "ip" | "document" | "global";
|
|
1688
|
+
source: PoaRuleSource;
|
|
1689
|
+
kinds: HostedPoaRuleKindView[];
|
|
1690
|
+
}
|
|
1691
|
+
/** The open proof of address step (`HostedSessionView.proofOfAddress`). */
|
|
1692
|
+
interface HostedProofOfAddressView {
|
|
1693
|
+
rule: HostedPoaRuleView;
|
|
1694
|
+
nameMatch: PoaNameMatchMode;
|
|
1695
|
+
/** `holder_letter` once the bill was read under `third_party_letter` and the step waits for the holder's letter. */
|
|
1696
|
+
phase: "document" | "holder_letter";
|
|
1697
|
+
/** Where the pages come from ({@link PhotoSource}). */
|
|
1698
|
+
source: PhotoSource;
|
|
1699
|
+
/** The person's pick under `choice`, once made for this step. */
|
|
1700
|
+
sourcePick?: PhotoSourcePick;
|
|
1701
|
+
/** An upload would be accepted now. */
|
|
1702
|
+
uploadOffered: boolean;
|
|
1703
|
+
/** Pages per document, at most. */
|
|
1704
|
+
maxPages: 3;
|
|
1705
|
+
/** A PDF upload's limits. */
|
|
1706
|
+
pdf: {
|
|
1707
|
+
maxBytes: number;
|
|
1708
|
+
maxPages: 3;
|
|
1709
|
+
};
|
|
1710
|
+
/**
|
|
1711
|
+
* Spec 2026-11-10 §5.3 licence shortcut: the step accepts the address of the driving licence read earlier in the
|
|
1712
|
+
* session, so the person may continue without a document ({@link PoaLicenceInput}). Present only in the `document`
|
|
1713
|
+
* phase.
|
|
1714
|
+
*/
|
|
1715
|
+
licenceAddressAccepted?: true;
|
|
1716
|
+
}
|
|
1717
|
+
/**
|
|
1718
|
+
* `poa` executor input (spec 2026-11-10 §7): the document (or, in the `holder_letter` phase, the holder's letter) as
|
|
1719
|
+
* 1 to 3 promoted page images, or as one promoted PDF (`document_file` media kind).
|
|
1720
|
+
*/
|
|
1721
|
+
type PoaInput = PoaImagesInput | PoaPdfInput | PoaLicenceInput;
|
|
1722
|
+
/**
|
|
1723
|
+
* The licence shortcut (spec 2026-11-10 §5.3): no media; the server decides from the driving licence read earlier in
|
|
1724
|
+
* the session. Only while the view's `proofOfAddress.licenceAddressAccepted` is set.
|
|
1725
|
+
*/
|
|
1726
|
+
interface PoaLicenceInput {
|
|
1727
|
+
part: "document";
|
|
1728
|
+
}
|
|
1729
|
+
/** The pages as images, in order. */
|
|
1730
|
+
interface PoaImagesInput {
|
|
1731
|
+
part: "document" | "holder_letter";
|
|
1732
|
+
source: PhotoSourcePick;
|
|
1733
|
+
/** 1 to 3 promoted `image` keys. */
|
|
1734
|
+
imageKeys: string[];
|
|
1735
|
+
}
|
|
1736
|
+
/** The document as one PDF (always picked from the device). */
|
|
1737
|
+
interface PoaPdfInput {
|
|
1738
|
+
part: "document" | "holder_letter";
|
|
1739
|
+
source: "upload";
|
|
1740
|
+
/** The promoted `document_file` key. */
|
|
1741
|
+
pdfKey: string;
|
|
1742
|
+
}
|
|
1623
1743
|
/** doc_ocr executor input: a promoted `doc-images/…` key + which side it shows. */
|
|
1624
1744
|
interface DocOcrInput {
|
|
1625
1745
|
imageKey: string;
|
|
@@ -1635,6 +1755,11 @@ interface DocOcrInput {
|
|
|
1635
1755
|
* view's `documents.uploadOffered`; else 400 `document_upload_not_allowed`). Absent = `camera`.
|
|
1636
1756
|
*/
|
|
1637
1757
|
source?: PhotoSourcePick;
|
|
1758
|
+
/**
|
|
1759
|
+
* Spec 2026-11-10 §6.2: `drivers_license` when the person picked the driving licence, so the server reads both faces
|
|
1760
|
+
* with its document reader instead of the MRZ pipeline. Absent for every other type (the server keeps its path).
|
|
1761
|
+
*/
|
|
1762
|
+
documentType?: "drivers_license";
|
|
1638
1763
|
}
|
|
1639
1764
|
/** The `doc_ocr` device-read hint (identity-backend DeviceReadSchema; strict, text-free). */
|
|
1640
1765
|
interface DocDeviceRead {
|
|
@@ -1791,6 +1916,8 @@ interface CheckInputByType {
|
|
|
1791
1916
|
portrait_icao: PortraitIcaoInput;
|
|
1792
1917
|
/** SDK spec §3.2: the national eID sign-in. */
|
|
1793
1918
|
eid_auth: EidAuthInput;
|
|
1919
|
+
/** Spec 2026-11-10 §5: the proof of address pages or PDF. */
|
|
1920
|
+
poa: PoaInput;
|
|
1794
1921
|
}
|
|
1795
1922
|
/**
|
|
1796
1923
|
* Body of `POST /sessions/:id/checks/:checkType` (SubmitCheckSchema).
|
|
@@ -1806,4 +1933,4 @@ interface SubmitCheckBody {
|
|
|
1806
1933
|
forceOutcome?: "pass" | "fail" | "age_over" | "age_uncertain" | "age_under" | "age_unavailable";
|
|
1807
1934
|
}
|
|
1808
1935
|
|
|
1809
|
-
export { type
|
|
1936
|
+
export { type HostedVoiceView as $, type AcceptedDocumentType as A, type HostedDocumentsView as B, type CaptureContext as C, type DecisionReason as D, type EidAfterPass as E, type FaceMatchInput as F, type HostedEidView as G, type HostedAcceptedDocuments as H, type HostedEmailOtpView as I, type HostedFlowRef as J, type HostedIcaoPolicy as K, type HostedIntegrity as L, type HostedLivePhotoTuning as M, type HostedNativeCaptureTuning as N, type HostedOcrTuning as O, type HostedOtpView as P, type HostedPlanView as Q, type HostedPoaRuleKindView as R, type HostedPoaRuleView as S, type HostedPortraitPendingFix as T, type HostedPortraitView as U, type HostedProofOfAddressView as V, type HostedSessionView as W, type HostedSimulationView as X, type HostedStepView as Y, type HostedTesterGateView as Z, type HostedVoiceLocale as _, type AttestationInput as a, type CameraUnavailableCause as a$, type IcaoCriterion as a0, type IcaoReportEntry as a1, type IdentityConfirmDecision as a2, type IdentityMethod as a3, type IdentitySummarySource as a4, type IdentitySummaryView as a5, type LivenessCaptureInput as a6, type LivenessInput as a7, type LivenessReason as a8, type MatchReason as a9, type PopulationInput as aA, type PopulationReason as aB, type PortraitFix as aC, type PortraitFixReviewInput as aD, type PortraitIcaoInput as aE, type PortraitIcaoReason as aF, type PortraitOutputFormat as aG, type PresignRequest as aH, type PresignUploadResult as aI, type RecordConsentResult as aJ, type ResolvedCaptureMode as aK, type SessionDecidingStep as aL, type SessionFailureReason as aM, type SessionReason as aN, type SessionStatus as aO, type SessionStepView as aP, type SessionView as aQ, type SimulatedCaptureInput as aR, type StepResult as aS, type StepSection as aT, type SubmitCheckBody as aU, type TesterGateInput as aV, type TesterGateResponse as aW, type VerificationAssurance as aX, type VerificationLevel as aY, type ScreenRampColour as aZ, type AgeEstimationReason as a_, type MediaKind as aa, type MethodChoiceView as ab, type NationalEidOption as ac, type NfcChipReason as ad, type NfcStepView as ae, type OtpChoiceView as af, type PhoneCountryRule as ag, type PhoneFormat as ah, type PhoneOtpInput as ai, type PhoneOtpReason as aj, type PhotoSource as ak, type PhotoSourcePick as al, type PlanAttempts as am, type PlanChoiceKind as an, type PlanChoiceOption as ao, type PlanChoiceView as ap, type PlanSectionView as aq, type PlanStepView as ar, type PoaImagesInput as as, type PoaInput as at, type PoaKind as au, type PoaLicenceInput as av, type PoaNameMatchMode as aw, type PoaPdfInput as ax, type PoaReason as ay, type PoaRuleSource as az, type CaptureMode as b, type CaptureIssueReport as b0, type CaptureProvenance as b1, type HostedBranding as b2, type HostedBrandingColorKey as b3, type HostedLivenessCaptureTuning as b4, type IcaoCaptureTuning as b5, type RetakeHint as b6, type ScreenRampChallenge as b7, type ScreenRampPaint as b8, type ScreenRampRendered as b9, type ScreenRampReport as ba, ICAO_FALLBACK as bb, type IcaoProfile as bc, type ResolvedIcaoTuning as bd, resolveIcaoTuning as be, type PersonMask as bf, type BackgroundUniformity as bg, type CaptureNoncesResult as c, type CaptureProof as d, type CheckInputByType as e, type CheckReason as f, type CheckState as g, type CheckType as h, type ClosedBy as i, type CompleteMediaResult as j, type ConsentLocale as k, type ContactChannel as l, type DocDeviceRead as m, type DocOcrInput as n, type DocReason as o, type DocSide as p, type EidAuthInput as q, type EidReason as r, type EmailOtpInput as s, type EmailOtpReason as t, type FaceMatchReason as u, type HostedCaptureTuning as v, type HostedChallengeView as w, type HostedConsentView as x, type HostedDocumentCaptureTuning as y, type HostedDocumentScanTuning as z };
|