@sekyro/node 1.0.0-rc.16 → 1.0.0-rc.18
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 +70 -0
- package/README.md +171 -62
- package/dist/chunk-HQ4S5AND.js +1 -0
- package/dist/{chunk-IM3UCVDB.js → chunk-VO3VIX3L.js} +1 -1
- package/dist/{client-BDULrZqs.d.cts → client-B0zqD-HZ.d.cts} +761 -235
- package/dist/{client-BDULrZqs.d.ts → client-B0zqD-HZ.d.ts} +761 -235
- package/dist/connect/express/index.d.cts +2 -2
- package/dist/connect/express/index.d.ts +2 -2
- package/dist/connect/express/index.js +1 -1
- package/dist/connect/index.cjs +1 -1
- package/dist/connect/index.d.cts +2 -2
- package/dist/connect/index.d.ts +2 -2
- package/dist/connect/index.js +1 -1
- package/dist/connect/next/index.d.cts +2 -2
- package/dist/connect/next/index.d.ts +2 -2
- package/dist/connect/next/index.js +1 -1
- package/dist/{connector-B90Jh4fv.d.cts → connector-CPyS23b7.d.ts} +26 -13
- package/dist/{connector-BXzO5Wgf.d.ts → connector-Cs-y1iL9.d.cts} +26 -13
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +18 -15
- package/dist/index.d.ts +18 -15
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/sbom.cdx.json +7 -7
- package/dist/chunk-J6U2QY7M.js +0 -1
|
@@ -6,20 +6,54 @@
|
|
|
6
6
|
*
|
|
7
7
|
* @packageDocumentation
|
|
8
8
|
*/
|
|
9
|
-
/** Session lifecycle status. @public */
|
|
10
|
-
type SessionStatus = "created" | "in_progress" | "review_pending" | "completed" | "expired" | "failed";
|
|
11
9
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* A session
|
|
15
|
-
*
|
|
16
|
-
* attempt in {@link Session.supersededBy}: read the newer session for the
|
|
17
|
-
* verdict. `superseded` is no longer sent on the session view, its webhooks or
|
|
18
|
-
* the result token; it stays in this union for one release and may still
|
|
19
|
-
* appear on {@link PersonSession.outcome}.
|
|
10
|
+
* Session lifecycle status: `created` (nobody opened it yet), `in_progress`, `review_pending`
|
|
11
|
+
* (a step waits for a person's review), then one of the two finished statuses, `verified` or
|
|
12
|
+
* `not_verified`. A `not_verified` session says why in {@link Session.reason}; every finished
|
|
13
|
+
* session says who or what closed it in {@link Session.closedBy}.
|
|
20
14
|
* @public
|
|
21
15
|
*/
|
|
22
|
-
type
|
|
16
|
+
type SessionStatus = "created" | "in_progress" | "review_pending" | "verified" | "not_verified";
|
|
17
|
+
/**
|
|
18
|
+
* Why a `not_verified` session was not verified: `rejected` (a check decided against the
|
|
19
|
+
* person, or a reviewer did), `inconclusive` (no verdict could be reached: the model was
|
|
20
|
+
* unsure, the captures stayed unreadable, or a review was not decided by its deadline),
|
|
21
|
+
* `unavailable` (the check could not run), `abandoned` (the person left before a result),
|
|
22
|
+
* `not_opened` (nobody opened the link), `policy` (a flow rule stopped it), `cancelled` (you
|
|
23
|
+
* cancelled it) or `superseded` (a newer session of the same person took its review over).
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
type SessionReason = "rejected" | "inconclusive" | "unavailable" | "abandoned" | "not_opened" | "policy" | "cancelled" | "superseded";
|
|
27
|
+
/**
|
|
28
|
+
* Who or what closed a finished session: `automatic` (the checks), `reviewer` (a person's
|
|
29
|
+
* review), `deadline` (the review deadline passed), `expiry` (the link expired) or
|
|
30
|
+
* `organization` (you cancelled it).
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
type ClosedBy = "automatic" | "reviewer" | "deadline" | "expiry" | "organization";
|
|
34
|
+
/**
|
|
35
|
+
* What a step's last counted attempt said: `passed`, `rejected`, `inconclusive`, `unreadable`
|
|
36
|
+
* (the capture could not be used), `unavailable` (the check could not run) or `review`.
|
|
37
|
+
* Absent before the first counted attempt.
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
type StepResult = "passed" | "rejected" | "inconclusive" | "unreadable" | "unavailable" | "review";
|
|
41
|
+
/**
|
|
42
|
+
* A step's counted attempts and its cap: `used >= max` means no attempt is left.
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
interface SessionStepAttempts {
|
|
46
|
+
used: number;
|
|
47
|
+
max: number;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* The step that decided a `not_verified` session: its node id in your flow and its service.
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
interface SessionDecidingStep {
|
|
54
|
+
id: string;
|
|
55
|
+
service: string;
|
|
56
|
+
}
|
|
23
57
|
/**
|
|
24
58
|
* What a finished session proved: `1` a live, real person (human), `2` that
|
|
25
59
|
* person's identity (document, chip, registry or supplied data bound to the
|
|
@@ -45,17 +79,6 @@ interface LevelTarget {
|
|
|
45
79
|
min: VerificationLevel;
|
|
46
80
|
max: VerificationLevel;
|
|
47
81
|
}
|
|
48
|
-
/**
|
|
49
|
-
* Device and network risk facts of a finished session (booleans and a level
|
|
50
|
-
* word, never scores).
|
|
51
|
-
* @public
|
|
52
|
-
*/
|
|
53
|
-
interface ResultRisk {
|
|
54
|
-
level: "low" | "medium" | "high";
|
|
55
|
-
vpn: boolean;
|
|
56
|
-
ipDocumentMismatch: boolean;
|
|
57
|
-
deviceTampered: boolean;
|
|
58
|
-
}
|
|
59
82
|
/**
|
|
60
83
|
* What the liveness step verified about the capture itself: the device
|
|
61
84
|
* attestation, the capture proof and the injection signals.
|
|
@@ -89,11 +112,175 @@ interface AgeResult {
|
|
|
89
112
|
sigma?: number;
|
|
90
113
|
}
|
|
91
114
|
/** Another person the face already matched (duplicate search). @public */
|
|
92
|
-
interface
|
|
115
|
+
interface PersonRef {
|
|
93
116
|
/** That person's id, `per_` prefixed, as on `GET /people` and `Session.personId`. */
|
|
94
117
|
personId: string;
|
|
118
|
+
/** That person's latest reference of yours, when it has one. */
|
|
95
119
|
externalRef?: string;
|
|
96
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* What a signal is about: one kind of the catalog, the same on a session's
|
|
123
|
+
* {@link SessionSignal} and on a finding ({@link Signal}).
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
type SignalKind = "account_targeted" | "id_many_faces" | "duplicate_identity" | "device_farm" | "document_reuse" | "presentation_attack" | "probing" | "velocity" | "network" | "contact_reuse" | "age_probing" | "known_person_new_device" | "registry_burst" | "link_sharing" | "device_integrity" | "too_fast" | "account_volume" | "document_conflict";
|
|
127
|
+
/** How strong a signal is. @public */
|
|
128
|
+
type SignalSeverity = "low" | "medium" | "high";
|
|
129
|
+
/** The strength of the evidence that set a finding's severity. @public */
|
|
130
|
+
type SignalGrade = "strong" | "medium" | "weak";
|
|
131
|
+
/**
|
|
132
|
+
* One evidence code of the catalog: a fact behind a signal. Codes only, never
|
|
133
|
+
* a value.
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
type SignalEvidence = "injection_suspected" | "capture_tampered" | "capture_provenance_invalid" | "virtual_camera" | "repeated_spoof" | "identity_stop" | "identity_switch" | "registry_burst" | "many_faces" | "face_many_ids" | "dedup_match" | "digest_conflict" | "documents_only" | "subject_conflict" | "session_velocity" | "many_people" | "device_velocity_exceeded" | "counted_rejections" | "shared_device" | "print_only" | "location_mismatch" | "anonymizer_asn" | "vpn" | "tor" | "proxy" | "hosting" | "attestation_failed" | "emulator" | "hooking" | "debugger" | "webdriver" | "headless" | "rooted_device" | "no_device_id" | "too_fast" | "account_volume" | "identities_vary" | "contact_reuse" | "disposable_email" | "role_email" | "age_probing" | "image_reuse" | "document_altered" | "document_substitution" | "mrz_visual_mismatch" | "many_devices" | "new_device";
|
|
137
|
+
/**
|
|
138
|
+
* One signal on a session: a kind, a severity and the evidence behind it.
|
|
139
|
+
* Facts only, never a verdict. On {@link Session.signals}, the terminal
|
|
140
|
+
* `session.*` webhooks and {@link VerifiedResult.signals}.
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
interface SessionSignal {
|
|
144
|
+
kind: SignalKind;
|
|
145
|
+
/** The strongest grade of its evidence. */
|
|
146
|
+
severity: SignalSeverity;
|
|
147
|
+
/** The facts behind the signal, sorted (at most 16). */
|
|
148
|
+
evidence: SignalEvidence[];
|
|
149
|
+
/** `duplicate_identity` only: the other people the duplicate search matched (at most 10). */
|
|
150
|
+
details?: {
|
|
151
|
+
people: PersonRef[];
|
|
152
|
+
};
|
|
153
|
+
/** The finding (`sig_...`) that holds this session, once it is linked: read it with {@link SignalsApi.get}. */
|
|
154
|
+
signalId?: string;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* One of your blocks or rules that flagged the session (`flag`) or held it
|
|
158
|
+
* for review (`review`). A `block` effect stops the session instead
|
|
159
|
+
* (`status: "not_verified"`, `reason: "policy"`, `reasonCode: "blocked_by_org"`).
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
interface BlockMatch {
|
|
163
|
+
/** The block (`blk_...`). */
|
|
164
|
+
blockId: string;
|
|
165
|
+
effect: "flag" | "review";
|
|
166
|
+
/** The rule (`rul_...`) that made the block, on a block made by a rule. */
|
|
167
|
+
ruleId?: string;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* A finding's status: `open`, `reviewed` or `false_positive` (your mark), or
|
|
171
|
+
* `closed` (it went quiet or no longer holds).
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
type SignalStatus = "open" | "reviewed" | "false_positive" | "closed";
|
|
175
|
+
/** What the sessions of a finding share. @public */
|
|
176
|
+
type SignalKeyKind = "external_ref" | "id_number" | "face_cluster" | "device" | "doc_image" | "contact_phone" | "contact_email" | "person" | "spike" | "asn" | "link";
|
|
177
|
+
/**
|
|
178
|
+
* A finding: sessions of this environment that share a key (a device, an ID
|
|
179
|
+
* number, an account, a contact, a network) and met a pattern. Never a value
|
|
180
|
+
* or a hash: `label` is four characters derived from the key. Read with
|
|
181
|
+
* {@link SignalsApi}.
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
interface Signal {
|
|
185
|
+
/** `sig_...` */
|
|
186
|
+
id: string;
|
|
187
|
+
kind: SignalKind;
|
|
188
|
+
severity: SignalSeverity;
|
|
189
|
+
grade: SignalGrade;
|
|
190
|
+
status: SignalStatus;
|
|
191
|
+
keyKind: SignalKeyKind;
|
|
192
|
+
/** Four characters derived from the key. */
|
|
193
|
+
label: string;
|
|
194
|
+
/** Why it has this severity. */
|
|
195
|
+
evidence: SignalEvidence[];
|
|
196
|
+
/** The sessions of the finding, by step result. */
|
|
197
|
+
counts: {
|
|
198
|
+
sessions: number;
|
|
199
|
+
failed: number;
|
|
200
|
+
passed: number;
|
|
201
|
+
review: number;
|
|
202
|
+
};
|
|
203
|
+
/** Distinct people among the sessions. */
|
|
204
|
+
people: number;
|
|
205
|
+
/** Distinct devices among the sessions. */
|
|
206
|
+
devices: number;
|
|
207
|
+
/** The sessions (`ses_...`), newest first (at most 200). */
|
|
208
|
+
sessionIds: string[];
|
|
209
|
+
/** The people (`per_...`) among the sessions (at most 50). */
|
|
210
|
+
personIds: string[];
|
|
211
|
+
/** ISO 8601: oldest session. */
|
|
212
|
+
firstAt: string;
|
|
213
|
+
/** ISO 8601: newest session. */
|
|
214
|
+
lastAt: string;
|
|
215
|
+
/** ISO 8601: when you last set the status. */
|
|
216
|
+
reviewedAt?: string;
|
|
217
|
+
/** Your note. */
|
|
218
|
+
note?: string;
|
|
219
|
+
/** Why it closed, on a closed finding. */
|
|
220
|
+
closedReason?: "rules_changed" | "disabled" | "quiet" | "under_threshold";
|
|
221
|
+
/** ISO 8601: when it closed, on a closed finding. */
|
|
222
|
+
closedAt?: string;
|
|
223
|
+
/** ISO 8601: when it was first raised. */
|
|
224
|
+
createdAt: string;
|
|
225
|
+
/** ISO 8601: when it last changed. */
|
|
226
|
+
updatedAt: string;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Filters of {@link SignalsApi.list}, {@link SignalsApi.listPage} and
|
|
230
|
+
* {@link SignalsApi.iterate}, combined with AND. Newest activity first.
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
interface ListSignalsQuery {
|
|
234
|
+
kind?: SignalKind;
|
|
235
|
+
severity?: SignalSeverity;
|
|
236
|
+
/** Default `open`; `any` lists every status (closed findings for 30 days). */
|
|
237
|
+
status?: SignalStatus | "any";
|
|
238
|
+
/** Findings whose newest session is at or after this time (ISO 8601 or a `Date`). */
|
|
239
|
+
since?: string | Date;
|
|
240
|
+
/** Findings whose newest session is at or before this time (ISO 8601 or a `Date`). */
|
|
241
|
+
until?: string | Date;
|
|
242
|
+
/** Page size, 1 to 100 (the API's default is 50). */
|
|
243
|
+
limit?: number;
|
|
244
|
+
/** The {@link Page.nextCursor} of the previous page. */
|
|
245
|
+
cursor?: string;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* Your mark on a finding, with {@link SignalsApi.update}. `open` opens a
|
|
249
|
+
* reviewed, false positive or closed finding again; `closed` is never set by
|
|
250
|
+
* a caller.
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
interface UpdateSignalInput {
|
|
254
|
+
status: "reviewed" | "false_positive" | "open";
|
|
255
|
+
/** Your note, at most 500 characters. It shows in your dashboard. */
|
|
256
|
+
note?: string;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* `data` of `signal.raised` (a finding opened, or opened again) and
|
|
260
|
+
* `signal.escalated` (its severity rose). Never the sessions or the people:
|
|
261
|
+
* read the finding with {@link SignalsApi.get}.
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
interface SignalEventData {
|
|
265
|
+
/** The finding (`sig_...`). */
|
|
266
|
+
signalId: string;
|
|
267
|
+
kind: SignalKind;
|
|
268
|
+
/** Its severity now. */
|
|
269
|
+
severity: SignalSeverity;
|
|
270
|
+
grade: SignalGrade;
|
|
271
|
+
/** `signal.raised` only: always `open`. */
|
|
272
|
+
status?: "open";
|
|
273
|
+
/** `signal.escalated` only: the severity before. */
|
|
274
|
+
previousSeverity?: SignalSeverity;
|
|
275
|
+
/** ISO 8601: oldest session. */
|
|
276
|
+
firstAt: string;
|
|
277
|
+
/** ISO 8601: newest session. */
|
|
278
|
+
lastAt: string;
|
|
279
|
+
/** `signal.raised` only, ISO 8601: when it opened. */
|
|
280
|
+
raisedAt?: string;
|
|
281
|
+
/** `signal.escalated` only, ISO 8601: when the severity rose. */
|
|
282
|
+
escalatedAt?: string;
|
|
283
|
+
}
|
|
97
284
|
/**
|
|
98
285
|
* How a `person.reuse` session runs: `recheck` verifies the same person
|
|
99
286
|
* again (liveness and face match against the stored photo), `step_up` raises
|
|
@@ -166,20 +353,6 @@ type DecisionReason = "liveness_inconclusive" | "match_inconclusive" | "document
|
|
|
166
353
|
* @public
|
|
167
354
|
*/
|
|
168
355
|
type EligibilityReason = "document_type_not_accepted" | "nationality_not_allowed" | "underage" | "age_unverifiable" | "underage_estimated";
|
|
169
|
-
/**
|
|
170
|
-
* Why a profile-v2 policy ended a session: a session-level
|
|
171
|
-
* {@link SessionFailureReason} (location / anonymizer gate), or the failed
|
|
172
|
-
* check's policy reason — an {@link EligibilityReason} or
|
|
173
|
-
* `document_id_number_mismatch` (the document belongs to someone other than the
|
|
174
|
-
* ID number the session was created for; `document_nni_mismatch` is its former
|
|
175
|
-
* name, still sent until the API switches to the new names), or `camera_unavailable` (spec 2026-10-29 §3.4: the person had no usable camera,
|
|
176
|
-
* so the live step ended without a capture; the session is rejected at level 0 unless your flow has a fallback),
|
|
177
|
-
* `subject_face_mismatch` (a step-up whose face did not match the person it was created for), or a review that
|
|
178
|
-
* ended at its deadline: `review_timeout` (nobody decided it) or `review_split` (two reviewers disagreed and
|
|
179
|
-
* nobody settled it); those two carry `decidedBy: "automatic"`.
|
|
180
|
-
* @public
|
|
181
|
-
*/
|
|
182
|
-
type PolicyFailureReason = SessionFailureReason | EligibilityReason | "document_id_number_mismatch" | "document_nni_mismatch" | "camera_unavailable" | "subject_face_mismatch" | "review_timeout" | "review_split" | "aml_hit";
|
|
183
356
|
/**
|
|
184
357
|
* The ID-number reasons a check's {@link SessionStep.reason} may carry (person data
|
|
185
358
|
* spec Appendix A.2), each under its generic name and its former Mauritanian name:
|
|
@@ -194,7 +367,8 @@ type IdNumberReason = "id_number_invalid" | "nni_invalid" | "registry_record_not
|
|
|
194
367
|
/**
|
|
195
368
|
* Why the person had no camera (spec 2026-10-29 §3.4, 2026-10-30), when the SDK said: `denied` (the
|
|
196
369
|
* person refused camera access) or `no_camera` (no usable camera: none found, an insecure page or a
|
|
197
|
-
* browser that cannot capture).
|
|
370
|
+
* browser that cannot capture). On the step's {@link SessionStep.reasonDetail} when its reason is
|
|
371
|
+
* `camera_unavailable` (the session's `reasonCode` is then `camera_unavailable`), never a reason of its own.
|
|
198
372
|
* @public
|
|
199
373
|
*/
|
|
200
374
|
type CameraUnavailableCause = "denied" | "no_camera";
|
|
@@ -208,21 +382,21 @@ type CameraUnavailableCause = "denied" | "no_camera";
|
|
|
208
382
|
*/
|
|
209
383
|
type MatchReason = "name_mismatch" | "birth_date_mismatch" | "nationality_mismatch" | "document_number_mismatch";
|
|
210
384
|
/**
|
|
211
|
-
*
|
|
212
|
-
* human review of the same person, reference photo and face
|
|
213
|
-
* score instead of a new review: `prior_review_approved` (the step
|
|
214
|
-
* final)
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
* `source: "prior_review"` and names your earlier session.
|
|
385
|
+
* Reason a `face_match` {@link SessionStep.reason} carries when an earlier
|
|
386
|
+
* human review of the same person, reference photo and face approved the
|
|
387
|
+
* match score instead of a new review: `prior_review_approved` (the step
|
|
388
|
+
* passed; final). It is billed like `review_band`. The step's
|
|
389
|
+
* {@link SessionStep.decision} has `source: "prior_review"` and names your
|
|
390
|
+
* earlier session.
|
|
218
391
|
* @public
|
|
219
392
|
*/
|
|
220
|
-
type PriorReviewReason = "prior_review_approved"
|
|
393
|
+
type PriorReviewReason = "prior_review_approved";
|
|
221
394
|
/**
|
|
222
|
-
*
|
|
395
|
+
* Reasons any reviewable step may carry when its review ends without a verdict: `superseded_by_retry`
|
|
223
396
|
* (a newer attempt of the same person took the review over; the session ends
|
|
224
|
-
* with `
|
|
225
|
-
* nobody settled it before the review deadline; the session
|
|
397
|
+
* `not_verified` with `reason: superseded` and {@link Session.supersededBy}) and `review_split` (two
|
|
398
|
+
* reviewers disagreed and nobody settled it before the review deadline; the session ends `not_verified`
|
|
399
|
+
* with `reason: inconclusive` and `closedBy: deadline`).
|
|
226
400
|
* Both are billed and retryable: the person may verify again. Neither counts
|
|
227
401
|
* toward the device cooldown.
|
|
228
402
|
* @public
|
|
@@ -309,6 +483,16 @@ type ProbeBindingReason = "probe_not_from_liveness";
|
|
|
309
483
|
type Locale = "ar" | "fr" | "en" | "es" | "pt" | "de";
|
|
310
484
|
/** The environment a webhook was emitted from. @public */
|
|
311
485
|
type SekyroEnvironment = "sandbox" | "live";
|
|
486
|
+
/**
|
|
487
|
+
* The shown band a scored step decided on ({@link SessionStep.band}), 0 to 1.
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
interface SessionStepBand {
|
|
491
|
+
/** Below this score the step fails. */
|
|
492
|
+
failBelow: number;
|
|
493
|
+
/** At or above this score the step passes. */
|
|
494
|
+
passAtOrAbove: number;
|
|
495
|
+
}
|
|
312
496
|
/**
|
|
313
497
|
* One check of a session, as the partner API projects it: enum/id fields only,
|
|
314
498
|
* never civil data.
|
|
@@ -328,8 +512,16 @@ interface SessionStep {
|
|
|
328
512
|
reasonDetail?: CameraUnavailableCause;
|
|
329
513
|
/** Calibrated model score in [0, 1] for scored checks (liveness, face match). */
|
|
330
514
|
calibratedScore?: number;
|
|
331
|
-
/**
|
|
332
|
-
|
|
515
|
+
/**
|
|
516
|
+
* The lines the step decided on, on the same 0 to 1 scale as `calibratedScore`: below
|
|
517
|
+
* `failBelow` the step fails, at or above `passAtOrAbove` it passes, between them it is
|
|
518
|
+
* reviewed or retried. Liveness and face match steps only.
|
|
519
|
+
*/
|
|
520
|
+
band?: SessionStepBand;
|
|
521
|
+
/** What the last counted attempt said ({@link StepResult}); absent before the first one. */
|
|
522
|
+
result?: StepResult;
|
|
523
|
+
/** Counted attempts and the cap ({@link SessionStepAttempts}): `used >= max` means none is left. */
|
|
524
|
+
attempts: SessionStepAttempts;
|
|
333
525
|
/**
|
|
334
526
|
* `portrait_icao` only (ID mode): the per-criterion ICAO report of the last
|
|
335
527
|
* attempt — numbers and enums only, never the image.
|
|
@@ -348,6 +540,52 @@ interface SessionStep {
|
|
|
348
540
|
decision?: SessionStepDecision;
|
|
349
541
|
/** The step last ran simulated in the Sandbox (no paid or external service). */
|
|
350
542
|
simulated?: true;
|
|
543
|
+
/** `doc_ocr` only: how the document was captured, and what an upload showed. */
|
|
544
|
+
document?: SessionStepDocument;
|
|
545
|
+
/** `portrait_icao` only (the ID photo step): how the delivered photo was produced. */
|
|
546
|
+
portrait?: SessionStepPortrait;
|
|
547
|
+
/**
|
|
548
|
+
* `face_match` only: what the live face was compared with: a registry photo,
|
|
549
|
+
* the document chip's photo, the printed document photo, or a photo of the
|
|
550
|
+
* person (a returning person or the photo you supplied).
|
|
551
|
+
*/
|
|
552
|
+
referenceSource?: "registry" | "chip" | "document" | "person";
|
|
553
|
+
}
|
|
554
|
+
/**
|
|
555
|
+
* {@link SessionStep.document}: filmed with the camera, or a file the person
|
|
556
|
+
* uploaded, and what the upload showed.
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
interface SessionStepDocument {
|
|
560
|
+
source: "camera" | "upload";
|
|
561
|
+
/**
|
|
562
|
+
* Upload only (non-empty only): `edited` (an editing tool or a screenshot),
|
|
563
|
+
* `recaptured` (a photo of a screen or a print), `compressed` (heavily compressed).
|
|
564
|
+
*/
|
|
565
|
+
findings?: Array<"edited" | "recaptured" | "compressed">;
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
* {@link SessionStep.portrait}: how the delivered ID photo was produced. Codes
|
|
569
|
+
* and numbers only: fetch the photos as the `icao_portrait` media.
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
interface SessionStepPortrait {
|
|
573
|
+
/** Where the photo came from. */
|
|
574
|
+
source?: "camera" | "upload";
|
|
575
|
+
/** The delivered format. */
|
|
576
|
+
output?: "icao_9303" | "photo_35x45_300dpi" | "square_600";
|
|
577
|
+
/** What was corrected on the delivered photo, never the face. */
|
|
578
|
+
fixes: Array<"crop" | "scale" | "straighten" | "background" | "exposure" | "white_balance">;
|
|
579
|
+
/** When the flow has a face match: the delivered photo compared with its reference photo. */
|
|
580
|
+
referenceMatch?: {
|
|
581
|
+
status: "scored" | "no_reference";
|
|
582
|
+
score?: number;
|
|
583
|
+
passed?: boolean;
|
|
584
|
+
};
|
|
585
|
+
/** Present and `false` only: no liveness capture to compare the photo with. */
|
|
586
|
+
bound?: false;
|
|
587
|
+
/** Present and `false` only: the photo passed with an alert, it does not meet the ICAO rules. */
|
|
588
|
+
compliant?: false;
|
|
351
589
|
}
|
|
352
590
|
/**
|
|
353
591
|
* The probe-quality measurement on a `face_match` step. Numbers only; `null`
|
|
@@ -792,17 +1030,140 @@ interface SessionFlowRef {
|
|
|
792
1030
|
version: number;
|
|
793
1031
|
}
|
|
794
1032
|
/**
|
|
795
|
-
* Input of {@link
|
|
1033
|
+
* Input of {@link SessionTestApi.simulate}: where a simulated Sandbox session
|
|
1034
|
+
* ends. Each outcome is reached through the real engine (expiry, cancel,
|
|
1035
|
+
* supersession, reviewer decision), never by writing a status, so the
|
|
1036
|
+
* webhooks, the result token and the dashboard rows are the real ones.
|
|
796
1037
|
* @public
|
|
797
1038
|
*/
|
|
798
1039
|
interface SimulateSessionInput {
|
|
799
|
-
/**
|
|
800
|
-
|
|
1040
|
+
/** Where the session ends. */
|
|
1041
|
+
status: "verified" | "not_verified" | "review_pending";
|
|
801
1042
|
/**
|
|
802
|
-
*
|
|
803
|
-
*
|
|
1043
|
+
* `not_verified` only: why. Defaults to the reason the engine gives for the
|
|
1044
|
+
* path. A pair the outcome model cannot produce answers
|
|
1045
|
+
* `422 simulate_pair_invalid` with the valid pairs in `details.validPairs`.
|
|
804
1046
|
*/
|
|
805
|
-
reason?:
|
|
1047
|
+
reason?: SessionReason;
|
|
1048
|
+
/** Who closes the session. Defaults to the value the engine gives for the path. */
|
|
1049
|
+
closedBy?: ClosedBy;
|
|
1050
|
+
/**
|
|
1051
|
+
* `not_verified` closed `automatic` only: the detailed code a step on the
|
|
1052
|
+
* path ends with, e.g. `spoof_detected` ({@link Session.reasonCode}).
|
|
1053
|
+
*/
|
|
1054
|
+
reasonCode?: string;
|
|
1055
|
+
/** The service of the step that decides the outcome, e.g. `liveness`. */
|
|
1056
|
+
step?: ServiceId;
|
|
1057
|
+
/**
|
|
1058
|
+
* What happens once `status` is reached. After `review_pending`:
|
|
1059
|
+
* `decide:approve` and `decide:reject` record a reviewer decision, `retake`
|
|
1060
|
+
* asks the person for a retake (the session goes back to `in_progress` and
|
|
1061
|
+
* `session.retake_requested` is sent). With `verified`: `binding_retake`
|
|
1062
|
+
* stops at the face match whose probe does not bind to the liveness clip,
|
|
1063
|
+
* and the session waits for the person to retake their face.
|
|
1064
|
+
*/
|
|
1065
|
+
then?: "retake" | "decide:approve" | "decide:reject" | "binding_retake";
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* One client protection in a {@link ReadinessReport}: how often it tripped, and what Live's
|
|
1069
|
+
* posture would do.
|
|
1070
|
+
* @public
|
|
1071
|
+
*/
|
|
1072
|
+
interface ReadinessProtection {
|
|
1073
|
+
/** The organization's Live posture. */
|
|
1074
|
+
livePosture: "off" | "signal" | "enforce";
|
|
1075
|
+
/** Sessions of the window whose check carried the failing signal. */
|
|
1076
|
+
sessions: number;
|
|
1077
|
+
/** Of those, how many Live would have stopped (the posture is `enforce`). */
|
|
1078
|
+
wouldStopInLive: number;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* Result of {@link Sekyro.readiness}: what Live would change for your integration, from the key
|
|
1082
|
+
* environment's sessions of the last 30 days. Counts and ids only, never a person value.
|
|
1083
|
+
* @public
|
|
1084
|
+
*/
|
|
1085
|
+
interface ReadinessReport {
|
|
1086
|
+
env: "sandbox" | "live";
|
|
1087
|
+
/** The window counted (ISO 8601). */
|
|
1088
|
+
window: {
|
|
1089
|
+
from: string;
|
|
1090
|
+
to: string;
|
|
1091
|
+
days: number;
|
|
1092
|
+
};
|
|
1093
|
+
/** Sessions created in the window that were counted, newest first; `capped` when older ones were left out. */
|
|
1094
|
+
sessions: {
|
|
1095
|
+
counted: number;
|
|
1096
|
+
capped: boolean;
|
|
1097
|
+
};
|
|
1098
|
+
clientAttestation: {
|
|
1099
|
+
/** Native attestation (App Attest, Play Integrity) that did not pass. */
|
|
1100
|
+
deviceAttestation: ReadinessProtection;
|
|
1101
|
+
/** Uploads without a valid live-camera capture proof. */
|
|
1102
|
+
captureOrigin: ReadinessProtection;
|
|
1103
|
+
/** Automation and emulator signals: recorded in both environments, they never stop a session. */
|
|
1104
|
+
automation: {
|
|
1105
|
+
webdriver: number;
|
|
1106
|
+
headless: number;
|
|
1107
|
+
emulator: number;
|
|
1108
|
+
};
|
|
1109
|
+
};
|
|
1110
|
+
webhooks: {
|
|
1111
|
+
/** Enabled endpoints per environment. */
|
|
1112
|
+
endpoints: {
|
|
1113
|
+
sandbox: number;
|
|
1114
|
+
live: number;
|
|
1115
|
+
};
|
|
1116
|
+
/** Deliveries of this environment that failed or died in the window. */
|
|
1117
|
+
failedDeliveries: number;
|
|
1118
|
+
};
|
|
1119
|
+
registries: {
|
|
1120
|
+
/** The active flows with a registry step, and whether Live has registry access for them. */
|
|
1121
|
+
flows: Array<{
|
|
1122
|
+
flowId: string;
|
|
1123
|
+
name: string;
|
|
1124
|
+
liveAccess: boolean;
|
|
1125
|
+
}>;
|
|
1126
|
+
};
|
|
1127
|
+
limits: Array<{
|
|
1128
|
+
id: "api_requests" | "verifications_started";
|
|
1129
|
+
/** The value in force in Live, per minute. */
|
|
1130
|
+
live: number;
|
|
1131
|
+
/** The busiest minute of this environment in the last 24 hours (`null`: nothing counted). */
|
|
1132
|
+
peakPerMinute: number | null;
|
|
1133
|
+
/** Requests of this environment the limit refused in the last 7 days. */
|
|
1134
|
+
rejected7d: number;
|
|
1135
|
+
}>;
|
|
1136
|
+
/** The SDK versions the sessions used. */
|
|
1137
|
+
sdks: Array<{
|
|
1138
|
+
sdk: string;
|
|
1139
|
+
version: string;
|
|
1140
|
+
/** The lowest version Sekyro AI recommends for this platform (`null`: none). */
|
|
1141
|
+
recommended: string | null;
|
|
1142
|
+
outdated: boolean;
|
|
1143
|
+
}>;
|
|
1144
|
+
/** Whether your server verified result tokens. Not known yet: always `null`. */
|
|
1145
|
+
resultTokenVerification: null;
|
|
1146
|
+
}
|
|
1147
|
+
/**
|
|
1148
|
+
* Input of {@link WebhooksApi.test}.
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
interface WebhookTestInput {
|
|
1152
|
+
/**
|
|
1153
|
+
* The event to send as a realistic sample payload, with fresh ids and
|
|
1154
|
+
* timestamps. Defaults to `webhook.test`.
|
|
1155
|
+
*/
|
|
1156
|
+
event?: WebhookEventType;
|
|
1157
|
+
}
|
|
1158
|
+
/**
|
|
1159
|
+
* Result of {@link WebhooksApi.test}.
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
interface WebhookTestResult {
|
|
1163
|
+
/** `false` when no enabled endpoint of the key's environment subscribes to the event. */
|
|
1164
|
+
dispatched: boolean;
|
|
1165
|
+
/** The endpoints the event was queued for. */
|
|
1166
|
+
endpoints: number;
|
|
806
1167
|
}
|
|
807
1168
|
/**
|
|
808
1169
|
* The API key in use, from {@link Sekyro.me}. Never carries the secret.
|
|
@@ -937,10 +1298,13 @@ interface CreatedSession {
|
|
|
937
1298
|
subjectUse?: "reference" | "prefill";
|
|
938
1299
|
/**
|
|
939
1300
|
* With {@link CreateSessionInput.deliver} only: the send of the hosted link.
|
|
940
|
-
* `failed` never fails the create
|
|
1301
|
+
* `failed` never fails the create. `simulated: true` in the Sandbox when the
|
|
1302
|
+
* destination is not an enrolled tester's: the destination passed the same
|
|
1303
|
+
* checks as in Live and nothing is sent.
|
|
941
1304
|
*/
|
|
942
1305
|
delivery?: {
|
|
943
|
-
status: "queued" | "failed"
|
|
1306
|
+
status: "queued" | "failed";
|
|
1307
|
+
simulated?: true;
|
|
944
1308
|
};
|
|
945
1309
|
}
|
|
946
1310
|
/**
|
|
@@ -1020,11 +1384,6 @@ interface SessionNetwork {
|
|
|
1020
1384
|
countryChanged: boolean;
|
|
1021
1385
|
start: SessionNetworkEvent;
|
|
1022
1386
|
}
|
|
1023
|
-
/**
|
|
1024
|
-
* Device signals detected on the end user's device.
|
|
1025
|
-
* @public
|
|
1026
|
-
*/
|
|
1027
|
-
type SessionDeviceSignal = "webdriver" | "headless" | "emulator" | "rooted" | "jailbroken" | "debugger" | "hooking" | "virtual_camera";
|
|
1028
1387
|
/**
|
|
1029
1388
|
* End-user device summary; absent when not recorded.
|
|
1030
1389
|
* @public
|
|
@@ -1040,13 +1399,42 @@ interface SessionDevice {
|
|
|
1040
1399
|
model?: string;
|
|
1041
1400
|
/**
|
|
1042
1401
|
* Opaque device identity inside your organization and environment, stable across sessions
|
|
1043
|
-
* while the device keeps its install id.
|
|
1044
|
-
* header).
|
|
1402
|
+
* while the device keeps its install id. After a handoff, the identity of the mobile device
|
|
1403
|
+
* that continued. May be absent (for example without a device header).
|
|
1045
1404
|
*/
|
|
1046
1405
|
deviceId?: string;
|
|
1047
1406
|
/** Hashed device keys of this session, per organization. */
|
|
1048
1407
|
deviceKeys: string[];
|
|
1049
|
-
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* The computer a session started on before a handoff ({@link SessionHandoff.fromDevice}): its
|
|
1411
|
+
* summary only, no device id, keys or signals.
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1414
|
+
type SessionHandoffDevice = Pick<SessionDevice, "platform" | "sdk" | "os" | "osVersion" | "browser" | "browserVersion" | "deviceClass" | "model">;
|
|
1415
|
+
/**
|
|
1416
|
+
* The session started on a computer that was shown the QR code at a camera step, and (once a
|
|
1417
|
+
* mobile device sent the first camera capture) continued on a phone or tablet. From then on
|
|
1418
|
+
* {@link Session.device}, its `deviceId` included, describes that mobile device and
|
|
1419
|
+
* `fromDevice` the computer.
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
interface SessionHandoff {
|
|
1423
|
+
from: "desktop";
|
|
1424
|
+
/** What identified the computer: the request headers, or the Sekyro web SDK when they cannot tell. */
|
|
1425
|
+
fromSource: "headers" | "client";
|
|
1426
|
+
/** ISO 8601: when the computer was shown the handoff. */
|
|
1427
|
+
startedAt: string;
|
|
1428
|
+
/** Present once a mobile device sent the first camera capture. */
|
|
1429
|
+
to?: "mobile";
|
|
1430
|
+
/** What identified the mobile device: the request headers, the Sekyro web SDK, the Sekyro native SDK, or a passed device attestation. */
|
|
1431
|
+
toSource?: "headers" | "client" | "app" | "attestation";
|
|
1432
|
+
/** How the mobile device continued: an app whose device attestation passed, an app, or a browser. */
|
|
1433
|
+
continuedVia?: "attested_app" | "app" | "browser";
|
|
1434
|
+
/** ISO 8601: when the mobile device sent the first camera capture; absent while it has not. */
|
|
1435
|
+
continuedAt?: string;
|
|
1436
|
+
/** The computer the session started on, once its device was recorded. */
|
|
1437
|
+
fromDevice?: SessionHandoffDevice;
|
|
1050
1438
|
}
|
|
1051
1439
|
/**
|
|
1052
1440
|
* The national eID that verified the session's identity (the `eid_auth` check
|
|
@@ -1167,8 +1555,8 @@ type IdentitySources = Partial<Record<IdentityScalarKey, IdentitySource[]>>;
|
|
|
1167
1555
|
/**
|
|
1168
1556
|
* The identity data a session read (its document, chip, registry, eID or your
|
|
1169
1557
|
* supplied record), present once one identity step settled, whatever the
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1558
|
+
* status. On a person ({@link Person.identity}), the identity of the latest
|
|
1559
|
+
* verified session that read one. Every key is optional. Sent to you only (the
|
|
1172
1560
|
* session view, the person view and the terminal webhooks).
|
|
1173
1561
|
* @public
|
|
1174
1562
|
*/
|
|
@@ -1255,13 +1643,6 @@ interface MediaBytes {
|
|
|
1255
1643
|
contentType: string;
|
|
1256
1644
|
bytes: Uint8Array;
|
|
1257
1645
|
}
|
|
1258
|
-
/**
|
|
1259
|
-
* Who closed a completed or failed session: `review` when a person decided
|
|
1260
|
-
* the verdict (the deciding step carries its {@link SessionStepDecision}),
|
|
1261
|
-
* `automatic` otherwise (a review deadline included).
|
|
1262
|
-
* @public
|
|
1263
|
-
*/
|
|
1264
|
-
type DecidedBy = "automatic" | "review";
|
|
1265
1646
|
/**
|
|
1266
1647
|
* The whitelisted session view returned by {@link SessionsApi.get}. Never
|
|
1267
1648
|
* contains the client token.
|
|
@@ -1272,18 +1653,28 @@ interface Session {
|
|
|
1272
1653
|
/** Sekyro flows: the flow version the session runs (absent on sessions created before flows). */
|
|
1273
1654
|
flow?: SessionFlowRef;
|
|
1274
1655
|
status: SessionStatus;
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1656
|
+
/** `not_verified` only: why ({@link SessionReason}). */
|
|
1657
|
+
reason?: SessionReason;
|
|
1658
|
+
/**
|
|
1659
|
+
* `not_verified` only: the detailed code behind `reason`, when one exists: the deciding step's
|
|
1660
|
+
* reason (e.g. `spoof_detected`, `camera_unavailable`) or a session stop code
|
|
1661
|
+
* ({@link SessionFailureReason}, e.g. `device_cooldown`).
|
|
1662
|
+
*/
|
|
1663
|
+
reasonCode?: string;
|
|
1664
|
+
/** Finished sessions: who or what closed it ({@link ClosedBy}). */
|
|
1665
|
+
closedBy?: ClosedBy;
|
|
1666
|
+
/** `not_verified` only: the step that decided it, when one did. */
|
|
1667
|
+
step?: SessionDecidingStep;
|
|
1668
|
+
/** `closedBy: reviewer`: how the deciding step was decided. */
|
|
1669
|
+
decision?: SessionStepDecision;
|
|
1278
1670
|
/**
|
|
1279
|
-
*
|
|
1280
|
-
* review
|
|
1671
|
+
* `reason: superseded`: the newer session of the same person that took over
|
|
1672
|
+
* its review. Watch it instead.
|
|
1281
1673
|
*/
|
|
1282
1674
|
supersededBy?: string;
|
|
1283
1675
|
/**
|
|
1284
|
-
* What the session proved ({@link VerificationLevel}), on a
|
|
1285
|
-
*
|
|
1286
|
-
* active, and from older API versions.
|
|
1676
|
+
* What the session proved ({@link VerificationLevel}), on a finished
|
|
1677
|
+
* session: `0` when it is `not_verified`. Absent while the session is open.
|
|
1287
1678
|
*/
|
|
1288
1679
|
level?: VerificationLevel | null;
|
|
1289
1680
|
/** How the level was proved; `null` while the session is active. */
|
|
@@ -1302,16 +1693,10 @@ interface Session {
|
|
|
1302
1693
|
completedAt?: string | null;
|
|
1303
1694
|
/** End-user network context; absent when not recorded. */
|
|
1304
1695
|
network?: SessionNetwork;
|
|
1305
|
-
/** End-user device; absent when not recorded. */
|
|
1696
|
+
/** End-user device; absent when not recorded. After a handoff, the mobile device that continued. */
|
|
1306
1697
|
device?: SessionDevice;
|
|
1307
|
-
/**
|
|
1308
|
-
|
|
1309
|
-
* (location, anonymizer) or a failed check's policy reason (eligibility,
|
|
1310
|
-
* `document_nni_mismatch`). Absent otherwise.
|
|
1311
|
-
*/
|
|
1312
|
-
failureReason?: PolicyFailureReason;
|
|
1313
|
-
/** With failureReason `camera_unavailable`: why (`denied` or `no_camera`), when the SDK said. Absent otherwise. */
|
|
1314
|
-
failureDetail?: CameraUnavailableCause;
|
|
1698
|
+
/** Started on a computer, continued on a phone or tablet; absent when no handoff happened. */
|
|
1699
|
+
handoff?: SessionHandoff;
|
|
1315
1700
|
/** The person (`per_...`) this session is linked to, once that person has passed a verification (absent before that). */
|
|
1316
1701
|
personId?: string;
|
|
1317
1702
|
/** Your own id for the person, from `person.externalRef` at create. */
|
|
@@ -1327,7 +1712,7 @@ interface Session {
|
|
|
1327
1712
|
personConflict?: boolean;
|
|
1328
1713
|
/**
|
|
1329
1714
|
* ISO 8601 — when the end user's device may verify again; set with
|
|
1330
|
-
* `
|
|
1715
|
+
* `reasonCode: 'device_cooldown'`.
|
|
1331
1716
|
*/
|
|
1332
1717
|
retryAfter?: string;
|
|
1333
1718
|
/**
|
|
@@ -1336,12 +1721,13 @@ interface Session {
|
|
|
1336
1721
|
*/
|
|
1337
1722
|
overriddenFields?: string[];
|
|
1338
1723
|
/**
|
|
1339
|
-
*
|
|
1340
|
-
*
|
|
1341
|
-
*
|
|
1342
|
-
* person uploaded a photo of the document) — signals only, never a verdict by themselves.
|
|
1724
|
+
* The signals of the session ({@link SessionSignal}), at any status, from
|
|
1725
|
+
* the facts known so far (non-empty only): high severity first, then by
|
|
1726
|
+
* kind. Facts only, never a verdict by themselves.
|
|
1343
1727
|
*/
|
|
1344
|
-
|
|
1728
|
+
signals?: SessionSignal[];
|
|
1729
|
+
/** Your blocks and rules that flagged the session or held it for review (non-empty only). */
|
|
1730
|
+
blockMatches?: BlockMatch[];
|
|
1345
1731
|
/**
|
|
1346
1732
|
* `true` for a returning-user session (created with
|
|
1347
1733
|
* {@link SessionPersonInput.reuse}): liveness + face match against the
|
|
@@ -1364,7 +1750,7 @@ interface Session {
|
|
|
1364
1750
|
age?: AgeResult;
|
|
1365
1751
|
/**
|
|
1366
1752
|
* The identity data the session read ({@link Identity}), once one identity
|
|
1367
|
-
* step settled. On
|
|
1753
|
+
* step settled. On a verified returning-user session, with a key that also
|
|
1368
1754
|
* holds `people:read`, the identity stored on the person.
|
|
1369
1755
|
*/
|
|
1370
1756
|
identity?: Identity;
|
|
@@ -1375,10 +1761,6 @@ interface Session {
|
|
|
1375
1761
|
* (ES256 JWT, valid 10 minutes). Check it with {@link verifyResultToken}.
|
|
1376
1762
|
*/
|
|
1377
1763
|
resultToken?: string;
|
|
1378
|
-
/** Terminal sessions: other people the face matched in the duplicate search (non-empty only). */
|
|
1379
|
-
duplicates?: ResultDuplicate[];
|
|
1380
|
-
/** Terminal sessions: the duplicate search could not run. */
|
|
1381
|
-
dedupUnavailable?: true;
|
|
1382
1764
|
/**
|
|
1383
1765
|
* Terminal sessions: a failure identification match
|
|
1384
1766
|
* ({@link FailureIdentification}), present only for a match and only when the
|
|
@@ -1392,69 +1774,45 @@ interface Session {
|
|
|
1392
1774
|
screening?: SessionScreening;
|
|
1393
1775
|
}
|
|
1394
1776
|
/**
|
|
1395
|
-
*
|
|
1396
|
-
* `session.review_pending` | `session.completed` | `session.failed` |
|
|
1397
|
-
* `session.expired`). `outcome`, `decidedBy` and `steps` travel on
|
|
1398
|
-
* `completed` / `failed`, which are the one terminal event of a session: a
|
|
1399
|
-
* reviewer's decision arrives as one of them with `decidedBy: "review"` and
|
|
1400
|
-
* the `decision`. `review_pending` carries `steps` without an outcome;
|
|
1401
|
-
* `expired` carries the status and the session's refs (`flow`, person ids,
|
|
1402
|
-
* `overriddenFields`). `identity` and `media` (kinds only, never links) ride on
|
|
1403
|
-
* `completed` / `failed` when the platform sends them.
|
|
1777
|
+
* One step on a session webhook: ids and enums only, never outputs.
|
|
1404
1778
|
* @public
|
|
1405
1779
|
*/
|
|
1406
|
-
interface
|
|
1780
|
+
interface SessionEventStep {
|
|
1781
|
+
/** The node of your flow this step belongs to (e.g. `n_live`). Absent on sessions created before flows. */
|
|
1782
|
+
id?: string;
|
|
1783
|
+
/** What the step runs: the service of its node. */
|
|
1784
|
+
service?: ServiceId;
|
|
1785
|
+
state: CheckState;
|
|
1786
|
+
/** What the last counted attempt said ({@link StepResult}); absent before the first one. */
|
|
1787
|
+
result?: StepResult;
|
|
1788
|
+
/** Machine-readable reason of the last counted attempt, when it has one. */
|
|
1789
|
+
reason?: string;
|
|
1790
|
+
/** Counted attempts and the cap ({@link SessionStepAttempts}). */
|
|
1791
|
+
attempts: SessionStepAttempts;
|
|
1792
|
+
/** The step last ran simulated in the Sandbox. */
|
|
1793
|
+
simulated?: true;
|
|
1794
|
+
/** How a person decided this step ({@link SessionStepDecision}); absent when no person decided it. */
|
|
1795
|
+
decision?: SessionStepDecision;
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* The fields every session webhook with a `steps[]` list carries
|
|
1799
|
+
* (`session.review_pending`, `session.verified`, `session.not_verified`).
|
|
1800
|
+
* @public
|
|
1801
|
+
*/
|
|
1802
|
+
interface SessionEventDataBase {
|
|
1407
1803
|
/** The session id (`ses_...`). */
|
|
1408
1804
|
sessionId: string;
|
|
1409
1805
|
status: SessionStatus;
|
|
1410
|
-
|
|
1411
|
-
/** On `completed` / `failed`: who decided the verdict ({@link DecidedBy}). */
|
|
1412
|
-
decidedBy?: DecidedBy;
|
|
1413
|
-
/** On `completed` / `failed` with `decidedBy: "review"`: how the deciding step was decided. */
|
|
1414
|
-
decision?: SessionStepDecision;
|
|
1415
|
-
/** On `completed` / `failed`: the app the session belongs to. */
|
|
1806
|
+
/** The app the session belongs to. */
|
|
1416
1807
|
appId?: string;
|
|
1417
|
-
/** On `completed` / `failed`: what the session proved ({@link VerificationLevel}). */
|
|
1418
|
-
level?: VerificationLevel | null;
|
|
1419
|
-
/** On `completed` / `failed`: how the level was proved. */
|
|
1420
|
-
assurance?: VerificationAssurance | null;
|
|
1421
|
-
/** On `completed` / `failed`: the billing unit the session consumed. */
|
|
1422
|
-
unit?: VerificationUnit | null;
|
|
1423
|
-
/** On `completed` / `failed`: ISO 8601 terminal time. */
|
|
1424
|
-
verifiedAt?: string;
|
|
1425
|
-
/** On `completed` / `failed`: device and network risk facts, when recorded. */
|
|
1426
|
-
risk?: ResultRisk;
|
|
1427
|
-
/** On `completed` / `failed`: other subjects the face matched, when a duplicate search ran. */
|
|
1428
|
-
duplicates?: ResultDuplicate[];
|
|
1429
|
-
/**
|
|
1430
|
-
* On `completed` / `failed`: the signed result token (ES256 JWT, valid
|
|
1431
|
-
* 10 minutes). Check it with {@link verifyResultToken}; absent when
|
|
1432
|
-
* result tokens are not enabled.
|
|
1433
|
-
*/
|
|
1434
|
-
resultToken?: string;
|
|
1435
|
-
/** On `completed` / `failed`: the duplicate search could not run. */
|
|
1436
|
-
dedupUnavailable?: true;
|
|
1437
|
-
/**
|
|
1438
|
-
* The checks on the session's path (checks of a lane the person did not take
|
|
1439
|
-
* are omitted), each with its {@link SessionStepDecision} when a person decided it.
|
|
1440
|
-
*/
|
|
1441
|
-
steps?: Array<Pick<SessionStep, "id" | "service" | "state" | "simulated" | "decision">>;
|
|
1442
1808
|
/** Sekyro flows: the flow version the session runs (absent on sessions created before flows). */
|
|
1443
1809
|
flow?: SessionFlowRef;
|
|
1444
|
-
/** Machine-readable reason, when the transition has one. */
|
|
1445
|
-
reason?: string;
|
|
1446
|
-
/** End-user network context (no IP); on `completed` / `failed` when recorded. */
|
|
1447
|
-
network?: Omit<SessionNetwork, "ip">;
|
|
1448
|
-
/** End-user device; on `completed` / `failed` when recorded. */
|
|
1449
|
-
device?: SessionDevice;
|
|
1450
1810
|
/**
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1453
|
-
*
|
|
1811
|
+
* The checks on the session's path (checks of a lane the person did not take
|
|
1812
|
+
* are omitted), each with its result, reason and attempts, and its
|
|
1813
|
+
* {@link SessionStepDecision} when a person decided it.
|
|
1454
1814
|
*/
|
|
1455
|
-
|
|
1456
|
-
/** On `session.failed` with failureReason `camera_unavailable`: why (`denied` or `no_camera`), when the SDK said. Absent otherwise. */
|
|
1457
|
-
failureDetail?: CameraUnavailableCause;
|
|
1815
|
+
steps?: SessionEventStep[];
|
|
1458
1816
|
/** The person (`per_...`) the session is linked to, once that person has passed a verification (absent before that). */
|
|
1459
1817
|
personId?: string;
|
|
1460
1818
|
/** Your own id for the person, from `person.externalRef` at create. */
|
|
@@ -1477,40 +1835,109 @@ interface SessionLifecycleEventData {
|
|
|
1477
1835
|
* again) or `step_up` (raised to identity level). Absent otherwise.
|
|
1478
1836
|
*/
|
|
1479
1837
|
reuseMode?: SubjectReuseMode;
|
|
1480
|
-
/**
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1838
|
+
/** Dotted paths the session's create-time {@link CreateSessionInput.overrides} changed. */
|
|
1839
|
+
overriddenFields?: string[];
|
|
1840
|
+
}
|
|
1841
|
+
/**
|
|
1842
|
+
* The fields of the two terminal events, `session.verified` and
|
|
1843
|
+
* `session.not_verified`. Each session sends exactly one of them.
|
|
1844
|
+
* @public
|
|
1845
|
+
*/
|
|
1846
|
+
interface SessionClosedEventDataBase extends SessionEventDataBase {
|
|
1847
|
+
/** Who or what closed the session ({@link ClosedBy}). */
|
|
1848
|
+
closedBy: ClosedBy;
|
|
1849
|
+
/** `closedBy: reviewer`: how the deciding step was decided. */
|
|
1850
|
+
decision?: SessionStepDecision;
|
|
1851
|
+
/** What the session proved ({@link VerificationLevel}); `0` on `session.not_verified`. */
|
|
1852
|
+
level?: VerificationLevel | null;
|
|
1853
|
+
/** How the level was proved. */
|
|
1854
|
+
assurance?: VerificationAssurance | null;
|
|
1855
|
+
/** The billing unit the session consumed. */
|
|
1856
|
+
unit?: VerificationUnit | null;
|
|
1857
|
+
/** ISO 8601: when the session closed. */
|
|
1858
|
+
verifiedAt?: string;
|
|
1859
|
+
/** The session's signals ({@link SessionSignal}, non-empty only). */
|
|
1860
|
+
signals?: SessionSignal[];
|
|
1861
|
+
/** Your blocks and rules that flagged the session or held it for review (non-empty only). */
|
|
1862
|
+
blockMatches?: BlockMatch[];
|
|
1863
|
+
/** End-user network context (no IP), when recorded. */
|
|
1864
|
+
network?: Omit<SessionNetwork, "ip">;
|
|
1865
|
+
/** End-user device, when recorded. */
|
|
1866
|
+
device?: SessionDevice;
|
|
1867
|
+
/** The `link.state` the session was created with, echoed back; absent when the session had none. */
|
|
1484
1868
|
link?: {
|
|
1485
1869
|
state: string;
|
|
1486
1870
|
};
|
|
1487
|
-
/**
|
|
1488
|
-
* On `session.failed` with `failureReason: 'device_cooldown'`: ISO time
|
|
1489
|
-
* from which the device may start a new verification.
|
|
1490
|
-
*/
|
|
1491
|
-
retryAfter?: string;
|
|
1492
|
-
/** Dotted paths the session's create-time {@link CreateSessionInput.overrides} changed. */
|
|
1493
|
-
overriddenFields?: string[];
|
|
1494
|
-
/** On `completed` / `failed`: the contacts verified in this session (passed OTP checks only). */
|
|
1871
|
+
/** The contacts verified in this session (passed OTP checks only). */
|
|
1495
1872
|
verifiedContacts?: VerifiedContacts;
|
|
1496
|
-
/**
|
|
1497
|
-
age?: AgeResult;
|
|
1498
|
-
/** On `completed` / `failed`: the identity data the session read ({@link Identity}), when the platform sends it. */
|
|
1873
|
+
/** The identity data the session read ({@link Identity}), when the platform sends it. */
|
|
1499
1874
|
identity?: Identity;
|
|
1500
|
-
/**
|
|
1875
|
+
/** The media kinds of the session (never links), when the platform sends them. */
|
|
1501
1876
|
media?: MediaKind[];
|
|
1502
1877
|
/**
|
|
1503
|
-
*
|
|
1504
|
-
*
|
|
1505
|
-
*
|
|
1878
|
+
* A failure identification match ({@link FailureIdentification}), when the
|
|
1879
|
+
* setting is on and the search found one before the event was sent. A
|
|
1880
|
+
* signal, never a decision.
|
|
1506
1881
|
*/
|
|
1507
1882
|
failureIdentification?: FailureIdentification;
|
|
1508
|
-
/**
|
|
1883
|
+
/** The AML screening result ({@link SessionScreening}), when the flow screens the person. */
|
|
1509
1884
|
screening?: SessionScreening;
|
|
1510
1885
|
}
|
|
1886
|
+
/**
|
|
1887
|
+
* `data` of `session.review_pending`: a step waits for a person's review. The
|
|
1888
|
+
* session stays open; its terminal event follows.
|
|
1889
|
+
* @public
|
|
1890
|
+
*/
|
|
1891
|
+
interface SessionReviewPendingEventData extends SessionEventDataBase {
|
|
1892
|
+
status: "review_pending";
|
|
1893
|
+
}
|
|
1894
|
+
/**
|
|
1895
|
+
* `data` of `session.verified`: the session is verified. The signed result
|
|
1896
|
+
* token rides on it when result tokens are on.
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
interface SessionVerifiedEventData extends SessionClosedEventDataBase {
|
|
1900
|
+
status: "verified";
|
|
1901
|
+
/** The minimum age the session proved and how ({@link AgeResult}), when the flow sets one. */
|
|
1902
|
+
age?: AgeResult;
|
|
1903
|
+
/**
|
|
1904
|
+
* The signed result token (ES256 JWT, valid 10 minutes). Check it with
|
|
1905
|
+
* {@link verifyResultToken}; absent when result tokens are not enabled.
|
|
1906
|
+
*/
|
|
1907
|
+
resultToken?: string;
|
|
1908
|
+
}
|
|
1909
|
+
/**
|
|
1910
|
+
* `data` of `session.not_verified`: the session closed without a
|
|
1911
|
+
* verification, for the {@link SessionReason} in `reason`. Expiry,
|
|
1912
|
+
* cancellation and supersession end this way too.
|
|
1913
|
+
* @public
|
|
1914
|
+
*/
|
|
1915
|
+
interface SessionNotVerifiedEventData extends SessionClosedEventDataBase {
|
|
1916
|
+
status: "not_verified";
|
|
1917
|
+
/** Why the session was not verified ({@link SessionReason}). */
|
|
1918
|
+
reason: SessionReason;
|
|
1919
|
+
/**
|
|
1920
|
+
* The detailed code behind `reason`, when one exists: the deciding step's
|
|
1921
|
+
* reason (e.g. `spoof_detected`) or a session stop code
|
|
1922
|
+
* ({@link SessionFailureReason}, e.g. `device_cooldown`).
|
|
1923
|
+
*/
|
|
1924
|
+
reasonCode?: string;
|
|
1925
|
+
/** The step that decided it, when one did. */
|
|
1926
|
+
step?: SessionDecidingStep;
|
|
1927
|
+
/** `reason: superseded`: the newer session of the same person (`ses_...`). */
|
|
1928
|
+
supersededBy?: string;
|
|
1929
|
+
/** `reasonCode: device_cooldown`: ISO time from which the device may start a new verification. */
|
|
1930
|
+
retryAfter?: string;
|
|
1931
|
+
}
|
|
1932
|
+
/**
|
|
1933
|
+
* `data` of the session events that carry `steps[]`: narrow on `status`
|
|
1934
|
+
* (`review_pending`, `verified` or `not_verified`).
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
type SessionLifecycleEventData = SessionReviewPendingEventData | SessionVerifiedEventData | SessionNotVerifiedEventData;
|
|
1511
1938
|
/**
|
|
1512
1939
|
* `data` of `person.updated`: either a session linked to the person reached
|
|
1513
|
-
* a terminal state (`sessionId`, session `status`, `
|
|
1940
|
+
* a terminal state (`sessionId`, session `status`, `reason`), or the person
|
|
1514
1941
|
* was revoked (`status: 'revoked'`, no session). Ids and enums only.
|
|
1515
1942
|
* @public
|
|
1516
1943
|
*/
|
|
@@ -1520,8 +1947,8 @@ interface PersonUpdatedEventData {
|
|
|
1520
1947
|
/** The session that reached a terminal state; absent on a revocation. */
|
|
1521
1948
|
sessionId?: string;
|
|
1522
1949
|
status: SessionStatus | "revoked";
|
|
1523
|
-
/**
|
|
1524
|
-
|
|
1950
|
+
/** `not_verified` sessions: why ({@link SessionReason}); absent on a revocation. */
|
|
1951
|
+
reason?: SessionReason;
|
|
1525
1952
|
/** The session's level; absent on a revocation. */
|
|
1526
1953
|
level?: VerificationLevel | null;
|
|
1527
1954
|
/** The session's assurance; absent on a revocation. */
|
|
@@ -1540,7 +1967,7 @@ interface PersonUpdatedEventData {
|
|
|
1540
1967
|
interface PersonEnrolledEventData {
|
|
1541
1968
|
/** The person (`per_...`). */
|
|
1542
1969
|
personId: string;
|
|
1543
|
-
/** The
|
|
1970
|
+
/** The verified session the reference photo came from. */
|
|
1544
1971
|
sessionId: string;
|
|
1545
1972
|
assurance: SubjectAssurance;
|
|
1546
1973
|
}
|
|
@@ -1588,7 +2015,8 @@ interface PersonSession {
|
|
|
1588
2015
|
/** ISO 8601 — when the session was linked. */
|
|
1589
2016
|
at: string;
|
|
1590
2017
|
status: SessionStatus;
|
|
1591
|
-
|
|
2018
|
+
/** `not_verified` sessions: why ({@link SessionReason}). */
|
|
2019
|
+
reason?: SessionReason;
|
|
1592
2020
|
/** What the session proved; present only when stored (sessions linked before the field existed have none). */
|
|
1593
2021
|
level?: VerificationLevel;
|
|
1594
2022
|
/** How the session's level was proved; present only when stored. */
|
|
@@ -1613,9 +2041,9 @@ interface Person {
|
|
|
1613
2041
|
firstSeenAt: string;
|
|
1614
2042
|
/** ISO 8601. */
|
|
1615
2043
|
lastSeenAt: string;
|
|
1616
|
-
/** ISO 8601, or `null` before the first
|
|
2044
|
+
/** ISO 8601, or `null` before the first verified session. */
|
|
1617
2045
|
lastPassedAt: string | null;
|
|
1618
|
-
/** ISO 8601 of the last
|
|
2046
|
+
/** ISO 8601 of the last verified full or returning session, or `null`. */
|
|
1619
2047
|
lastVerifiedAt: string | null;
|
|
1620
2048
|
/** The stored reference photo's origin and date — `null` until one is stored. */
|
|
1621
2049
|
reference: {
|
|
@@ -1624,12 +2052,12 @@ interface Person {
|
|
|
1624
2052
|
} | null;
|
|
1625
2053
|
assurance: SubjectAssurance | null;
|
|
1626
2054
|
/**
|
|
1627
|
-
* The highest {@link VerificationLevel}
|
|
2055
|
+
* The highest {@link VerificationLevel} a verified linked session proved;
|
|
1628
2056
|
* `0` once the subject is revoked; `null` when no terminal session was
|
|
1629
2057
|
* recorded since the field exists. Absent from API versions before the field.
|
|
1630
2058
|
*/
|
|
1631
2059
|
level?: VerificationLevel | null | undefined;
|
|
1632
|
-
/** ISO 8601: when {@link Person.level} was last proved (the latest
|
|
2060
|
+
/** ISO 8601: when {@link Person.level} was last proved (the latest verified session at that level or higher); `null` with it. Absent with it. */
|
|
1633
2061
|
levelAt?: string | null | undefined;
|
|
1634
2062
|
/** The assurance of the session that proved {@link Person.level}; `null` with it. Absent with it. */
|
|
1635
2063
|
levelAssurance?: VerificationAssurance | null | undefined;
|
|
@@ -1640,12 +2068,12 @@ interface Person {
|
|
|
1640
2068
|
* (`settings.returning`: turned on, and `maxAgeMonths` when set).
|
|
1641
2069
|
*/
|
|
1642
2070
|
returningReady: boolean;
|
|
1643
|
-
/** The verified name / birth date of the latest
|
|
2071
|
+
/** The verified name / birth date of the latest verified session. */
|
|
1644
2072
|
display?: {
|
|
1645
2073
|
name?: string;
|
|
1646
2074
|
birthDate?: string;
|
|
1647
2075
|
};
|
|
1648
|
-
/** The identity of the latest
|
|
2076
|
+
/** The identity of the latest verified session that read one ({@link Identity}). */
|
|
1649
2077
|
identity?: Identity;
|
|
1650
2078
|
}
|
|
1651
2079
|
/**
|
|
@@ -1657,6 +2085,10 @@ interface ListSessionsQuery {
|
|
|
1657
2085
|
/** Your own id for the person (1 to 128 characters), exact match. */
|
|
1658
2086
|
externalRef?: string;
|
|
1659
2087
|
status?: SessionStatus;
|
|
2088
|
+
/** Only `not_verified` sessions closed for this reason. */
|
|
2089
|
+
reason?: SessionReason;
|
|
2090
|
+
/** Only ended sessions closed this way. */
|
|
2091
|
+
closedBy?: ClosedBy;
|
|
1660
2092
|
/** A flow id (`flw_...`) or slug. */
|
|
1661
2093
|
flow?: string;
|
|
1662
2094
|
/** Sessions created at or after this time (ISO 8601 or a `Date`). */
|
|
@@ -1665,6 +2097,13 @@ interface ListSessionsQuery {
|
|
|
1665
2097
|
createdBefore?: string | Date;
|
|
1666
2098
|
/** Only the sessions of this device (`device.deviceId` of a session). */
|
|
1667
2099
|
deviceId?: string;
|
|
2100
|
+
/**
|
|
2101
|
+
* Only the sessions whose signals held this kind, or one of these kinds
|
|
2102
|
+
* (sent as a comma list), including findings since closed.
|
|
2103
|
+
*/
|
|
2104
|
+
signalKind?: SignalKind | SignalKind[];
|
|
2105
|
+
/** Only the sessions whose strongest signal reached at least this severity. */
|
|
2106
|
+
signalSeverity?: SignalSeverity;
|
|
1668
2107
|
/** Page size, 1 to 100 (the API's default is 50). */
|
|
1669
2108
|
limit?: number;
|
|
1670
2109
|
/** The {@link Page.nextCursor} of the previous page. */
|
|
@@ -1943,7 +2382,7 @@ interface ListScreeningsQuery {
|
|
|
1943
2382
|
interface AmlMatchFlaggedEventData {
|
|
1944
2383
|
screeningId: string;
|
|
1945
2384
|
trigger: ScreeningTrigger;
|
|
1946
|
-
/** The session the screening ran in, or the person's latest
|
|
2385
|
+
/** The session the screening ran in, or the person's latest verified session. */
|
|
1947
2386
|
sessionId?: string;
|
|
1948
2387
|
/** The person (`per_...`), once known. */
|
|
1949
2388
|
personId?: string;
|
|
@@ -1974,8 +2413,9 @@ type ExtendLinkInput = {
|
|
|
1974
2413
|
interface SessionLinkDelivery {
|
|
1975
2414
|
delivery: {
|
|
1976
2415
|
channel: "sms" | "whatsapp" | "email";
|
|
1977
|
-
|
|
1978
|
-
|
|
2416
|
+
status: "queued" | "sent" | "failed";
|
|
2417
|
+
/** `true` in the Sandbox when the destination is not an enrolled tester's: nothing is sent. */
|
|
2418
|
+
simulated?: true;
|
|
1979
2419
|
};
|
|
1980
2420
|
}
|
|
1981
2421
|
/** Result of {@link SessionsApi.extendLink}. @public */
|
|
@@ -1995,24 +2435,6 @@ interface PersonSuspiciousActivityEventData {
|
|
|
1995
2435
|
sessionId: string;
|
|
1996
2436
|
count: number;
|
|
1997
2437
|
}
|
|
1998
|
-
/**
|
|
1999
|
-
* `data` of `session.superseded`: a session that waited for a review closed
|
|
2000
|
-
* because a newer attempt of the same person took that review over. The
|
|
2001
|
-
* session ends with status `completed`, `outcome: null` and `supersededBy`;
|
|
2002
|
-
* its review step failed with `superseded_by_retry`; nothing of it is deleted.
|
|
2003
|
-
* Read the newer session (`supersededBy`) for the verdict. This is the one
|
|
2004
|
-
* terminal event of the superseded session.
|
|
2005
|
-
* @public
|
|
2006
|
-
*/
|
|
2007
|
-
interface SessionSupersededEventData {
|
|
2008
|
-
/** The superseded session (`ses_...`). */
|
|
2009
|
-
sessionId: string;
|
|
2010
|
-
/** The newer session of the same person that took the review over (`ses_...`). */
|
|
2011
|
-
supersededBy: string;
|
|
2012
|
-
reason: "superseded_by_retry";
|
|
2013
|
-
/** Your own id for the person, from `person.externalRef` at create. */
|
|
2014
|
-
externalRef?: string;
|
|
2015
|
-
}
|
|
2016
2438
|
/**
|
|
2017
2439
|
* `usage.threshold_reached`: a usage, credit or spend threshold of the organization's
|
|
2018
2440
|
* plan was reached (sent once per threshold and period). `kind` is `tier` for a monthly
|
|
@@ -2034,6 +2456,22 @@ interface UsageThresholdReachedEventData {
|
|
|
2034
2456
|
/** Tier alerts: verifications beyond the tier this month. */
|
|
2035
2457
|
overage?: number;
|
|
2036
2458
|
}
|
|
2459
|
+
/**
|
|
2460
|
+
* `data` of `session.retake_requested`: a reviewer sent the session back for a new capture of
|
|
2461
|
+
* one step. The session is open again until `expiresAt`.
|
|
2462
|
+
* @public
|
|
2463
|
+
*/
|
|
2464
|
+
interface SessionRetakeRequestedEventData {
|
|
2465
|
+
/** The session (`ses_...`). */
|
|
2466
|
+
sessionId: string;
|
|
2467
|
+
status: "in_progress";
|
|
2468
|
+
/** The step to capture again. */
|
|
2469
|
+
step: SessionDecidingStep;
|
|
2470
|
+
/** ISO 8601: the new link expiry. */
|
|
2471
|
+
expiresAt: string;
|
|
2472
|
+
/** Your own id for the person, from `person.externalRef` at create. */
|
|
2473
|
+
externalRef?: string;
|
|
2474
|
+
}
|
|
2037
2475
|
/**
|
|
2038
2476
|
* Event type → the shape of its `data`. Session events are typed; the
|
|
2039
2477
|
* remaining events carry an open record until their payloads are frozen.
|
|
@@ -2041,11 +2479,12 @@ interface UsageThresholdReachedEventData {
|
|
|
2041
2479
|
*/
|
|
2042
2480
|
interface WebhookEventDataMap {
|
|
2043
2481
|
"session.started": Record<string, unknown>;
|
|
2044
|
-
"session.review_pending":
|
|
2045
|
-
"session.
|
|
2046
|
-
"session.
|
|
2047
|
-
"session.
|
|
2048
|
-
"
|
|
2482
|
+
"session.review_pending": SessionReviewPendingEventData;
|
|
2483
|
+
"session.verified": SessionVerifiedEventData;
|
|
2484
|
+
"session.not_verified": SessionNotVerifiedEventData;
|
|
2485
|
+
"session.retake_requested": SessionRetakeRequestedEventData;
|
|
2486
|
+
"signal.raised": SignalEventData;
|
|
2487
|
+
"signal.escalated": SignalEventData;
|
|
2049
2488
|
"person.enrolled": PersonEnrolledEventData;
|
|
2050
2489
|
"person.updated": PersonUpdatedEventData;
|
|
2051
2490
|
"person.suspicious_activity": PersonSuspiciousActivityEventData;
|
|
@@ -2086,8 +2525,9 @@ interface WebhookEnvelopeOf<E extends WebhookEventType> {
|
|
|
2086
2525
|
* ```ts
|
|
2087
2526
|
* const envelope = verifyWebhook(rawBody, header, secret);
|
|
2088
2527
|
* switch (envelope.event) {
|
|
2089
|
-
* case "session.
|
|
2090
|
-
* envelope.data.
|
|
2528
|
+
* case "session.not_verified":
|
|
2529
|
+
* envelope.data.reason; // SessionReason
|
|
2530
|
+
* envelope.data.closedBy; // ClosedBy
|
|
2091
2531
|
* break;
|
|
2092
2532
|
* case "person.updated":
|
|
2093
2533
|
* envelope.data.personId; // "per_..."
|
|
@@ -2172,8 +2612,8 @@ declare class SessionsApi {
|
|
|
2172
2612
|
get(id: string): Promise<Session>;
|
|
2173
2613
|
/**
|
|
2174
2614
|
* `POST /sessions/:id/cancel` — stop a session that has not ended. The
|
|
2175
|
-
* hosted link stops working, and one `session.
|
|
2176
|
-
* `
|
|
2615
|
+
* hosted link stops working, and one `session.not_verified` with
|
|
2616
|
+
* `reason: "cancelled"` and `closedBy: "organization"` is sent. Returns the
|
|
2177
2617
|
* cancelled session. `409 session_not_cancellable` once the session has
|
|
2178
2618
|
* ended (a repeated cancel included). Needs the `sessions:create` scope.
|
|
2179
2619
|
*/
|
|
@@ -2212,7 +2652,7 @@ declare class SessionsApi {
|
|
|
2212
2652
|
*
|
|
2213
2653
|
* @example
|
|
2214
2654
|
* ```ts
|
|
2215
|
-
* for await (const s of sekyro.sessions.iterate({ status: "
|
|
2655
|
+
* for await (const s of sekyro.sessions.iterate({ status: "verified" })) {
|
|
2216
2656
|
* console.log(s.id);
|
|
2217
2657
|
* }
|
|
2218
2658
|
* ```
|
|
@@ -2234,23 +2674,12 @@ declare class SessionsApi {
|
|
|
2234
2674
|
mediaBytes(id: string, kind: MediaKind, opts?: MediaBytesOptions): Promise<MediaBytes>;
|
|
2235
2675
|
/**
|
|
2236
2676
|
* `GET /sessions/:id/result-token`: a freshly signed result token for a
|
|
2237
|
-
*
|
|
2677
|
+
* verified session (valid 10 minutes; check it with
|
|
2238
2678
|
* {@link verifyResultToken}). `409 session_not_terminal` while the session
|
|
2239
|
-
* is still
|
|
2679
|
+
* is still open, `409 session_not_verified` for a `not_verified` session
|
|
2680
|
+
* (it has no token). Needs the `sessions:read` scope.
|
|
2240
2681
|
*/
|
|
2241
2682
|
resultToken(id: string): Promise<ResultTokenResponse>;
|
|
2242
|
-
/**
|
|
2243
|
-
* `POST /sessions/:id/simulate`: finishes a simulated Sandbox session in one
|
|
2244
|
-
* call, for tests and CI. It runs every step of the flow through the real
|
|
2245
|
-
* engine, so the status, the webhooks, the result token and the dashboard
|
|
2246
|
-
* behave as for a session driven by a person. Never billed. Returns the
|
|
2247
|
-
* finished session; pass an `idempotencyKey` to make a retry safe. Errors:
|
|
2248
|
-
* `400 sandbox_only` (Live key), `409 session_not_simulated` (bound to a
|
|
2249
|
-
* tester), `409 session_already_final`, `422 simulate_outcome_unreachable`
|
|
2250
|
-
* (`details.issues` says why), `422 simulate_reason_invalid`. Needs the
|
|
2251
|
-
* `sessions:create` scope.
|
|
2252
|
-
*/
|
|
2253
|
-
simulate(id: string, input: SimulateSessionInput, opts?: RequestOptions): Promise<Session>;
|
|
2254
2683
|
}
|
|
2255
2684
|
/**
|
|
2256
2685
|
* `sekyro.flows`: the flows of the API key's app.
|
|
@@ -2338,7 +2767,7 @@ declare class PeopleApi {
|
|
|
2338
2767
|
/**
|
|
2339
2768
|
* `DELETE /people/:id` — deletes the person's stored photos, face
|
|
2340
2769
|
* templates and identifiers, and the personal data and media of their
|
|
2341
|
-
* sessions, which it unlinks (they keep their
|
|
2770
|
+
* sessions, which it unlinks (they keep their status and steps). Emits
|
|
2342
2771
|
* `person.deleted`. Cannot be undone; a second call answers `404`.
|
|
2343
2772
|
*/
|
|
2344
2773
|
delete(id: string): Promise<DeletedPerson>;
|
|
@@ -2390,6 +2819,38 @@ declare class BlocksApi {
|
|
|
2390
2819
|
/** `POST /blocks/check`: whether a value is blocked. A POST, so it never sits in a URL or a log. */
|
|
2391
2820
|
check(input: BlockCheckInput): Promise<BlockCheck>;
|
|
2392
2821
|
}
|
|
2822
|
+
/**
|
|
2823
|
+
* Findings: sessions of this environment that share a key and met a pattern
|
|
2824
|
+
* ({@link Signal}). Exposed as {@link Sekyro.signals}. Reading needs the
|
|
2825
|
+
* `signals:read` scope, {@link SignalsApi.update} `signals:write`. Every call
|
|
2826
|
+
* answers `403 signals_unavailable` while Signals are not available in the
|
|
2827
|
+
* environment. Exported as a TYPE only.
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
declare class SignalsApi {
|
|
2831
|
+
private readonly t;
|
|
2832
|
+
/** @internal */
|
|
2833
|
+
constructor(t: {
|
|
2834
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
2835
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
2836
|
+
});
|
|
2837
|
+
/**
|
|
2838
|
+
* The first page of the findings (`GET /signals`), newest activity first;
|
|
2839
|
+
* `open` ones unless `status` says otherwise. Every page: {@link SignalsApi.iterate}.
|
|
2840
|
+
*/
|
|
2841
|
+
list(query?: ListSignalsQuery): Promise<Signal[]>;
|
|
2842
|
+
/** One page of {@link SignalsApi.list} with its `nextCursor` (absent on the last page). */
|
|
2843
|
+
listPage(query?: ListSignalsQuery): Promise<Page<Signal>>;
|
|
2844
|
+
/** Every finding matching `query`, following `nextCursor` page after page. */
|
|
2845
|
+
iterate(query?: ListSignalsQuery): AsyncGenerator<Signal, void, undefined>;
|
|
2846
|
+
/** `GET /signals/:id`: `404 signal_not_found` for an id of another environment. */
|
|
2847
|
+
get(id: string): Promise<Signal>;
|
|
2848
|
+
/**
|
|
2849
|
+
* `PATCH /signals/:id`: mark a finding `reviewed` or `false_positive`, or
|
|
2850
|
+
* open it again (`open`), with an optional note. Answers the finding.
|
|
2851
|
+
*/
|
|
2852
|
+
update(id: string, input: UpdateSignalInput, opts?: RequestOptions): Promise<Signal>;
|
|
2853
|
+
}
|
|
2393
2854
|
/**
|
|
2394
2855
|
* What you know about a device before you block it. Exposed as {@link Sekyro.devices}. Needs the
|
|
2395
2856
|
* `blocks:read` or `blocks:write` scope. Exported as a TYPE only.
|
|
@@ -2411,6 +2872,59 @@ declare class DevicesApi {
|
|
|
2411
2872
|
shared: boolean;
|
|
2412
2873
|
}, opts?: RequestOptions): Promise<Device>;
|
|
2413
2874
|
}
|
|
2875
|
+
/**
|
|
2876
|
+
* `sekyro.webhooks`: your webhook endpoints. Exported as a TYPE only: obtained
|
|
2877
|
+
* through {@link Sekyro.webhooks}.
|
|
2878
|
+
* @public
|
|
2879
|
+
*/
|
|
2880
|
+
declare class WebhooksApi {
|
|
2881
|
+
private readonly t;
|
|
2882
|
+
/** @internal */
|
|
2883
|
+
constructor(t: {
|
|
2884
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
2885
|
+
});
|
|
2886
|
+
/**
|
|
2887
|
+
* `POST /webhooks/test`: sends a realistic sample of `event` (default
|
|
2888
|
+
* `webhook.test`) to the endpoints of the key's environment that subscribe
|
|
2889
|
+
* to it, signed like any delivery. Works with Sandbox and Live keys. Needs
|
|
2890
|
+
* the `webhooks:test` scope.
|
|
2891
|
+
*/
|
|
2892
|
+
test(input?: WebhookTestInput): Promise<WebhookTestResult>;
|
|
2893
|
+
}
|
|
2894
|
+
/**
|
|
2895
|
+
* `sekyro.test.sessions`: test tools for simulated Sandbox sessions. Keep them
|
|
2896
|
+
* out of your production code path: a Live key is refused. Exported as a TYPE
|
|
2897
|
+
* only: obtained through {@link SekyroTestApi.sessions}.
|
|
2898
|
+
* @public
|
|
2899
|
+
*/
|
|
2900
|
+
declare class SessionTestApi {
|
|
2901
|
+
private readonly t;
|
|
2902
|
+
/** @internal */
|
|
2903
|
+
constructor(t: {
|
|
2904
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
2905
|
+
});
|
|
2906
|
+
/**
|
|
2907
|
+
* `POST /sessions/:id/simulate`: ends a simulated Sandbox session with the
|
|
2908
|
+
* outcome you name, through the real engine, so the webhooks, the result
|
|
2909
|
+
* token and the dashboard behave as for a session driven by a person. Never
|
|
2910
|
+
* billed. Returns the session; pass an `idempotencyKey` to make a retry
|
|
2911
|
+
* safe. Errors: `400 sandbox_only` (a Live key), `409 session_bound` (a
|
|
2912
|
+
* tester runs real checks in it), `409 session_already_final`,
|
|
2913
|
+
* `422 simulate_pair_invalid` (`details.validPairs` lists the valid pairs),
|
|
2914
|
+
* `422 simulate_status_unreachable` (`details.issues` says why) and
|
|
2915
|
+
* `422 simulate_reason_invalid`. Needs the `sessions:create` scope.
|
|
2916
|
+
*/
|
|
2917
|
+
simulate(id: string, input: SimulateSessionInput, opts?: RequestOptions): Promise<Session>;
|
|
2918
|
+
}
|
|
2919
|
+
/**
|
|
2920
|
+
* `sekyro.test`: tools for tests and CI in the Sandbox. Exported as a TYPE only.
|
|
2921
|
+
* @public
|
|
2922
|
+
*/
|
|
2923
|
+
declare class SekyroTestApi {
|
|
2924
|
+
readonly sessions: SessionTestApi;
|
|
2925
|
+
/** @internal */
|
|
2926
|
+
constructor(t: ConstructorParameters<typeof SessionTestApi>[0]);
|
|
2927
|
+
}
|
|
2414
2928
|
/**
|
|
2415
2929
|
* Sekyro AI partner API client. Server-side only: it carries your API key.
|
|
2416
2930
|
*
|
|
@@ -2430,8 +2944,12 @@ declare class Sekyro {
|
|
|
2430
2944
|
readonly sessions: SessionsApi;
|
|
2431
2945
|
readonly people: PeopleApi;
|
|
2432
2946
|
readonly blocks: BlocksApi;
|
|
2947
|
+
readonly signals: SignalsApi;
|
|
2433
2948
|
readonly devices: DevicesApi;
|
|
2434
2949
|
readonly flows: FlowsApi;
|
|
2950
|
+
readonly webhooks: WebhooksApi;
|
|
2951
|
+
/** Test tools for the Sandbox: {@link SekyroTestApi}. */
|
|
2952
|
+
readonly test: SekyroTestApi;
|
|
2435
2953
|
constructor(opts: SekyroOptions);
|
|
2436
2954
|
/**
|
|
2437
2955
|
* `GET /me`: which key this is. Tells a Sandbox key from a Live one, and
|
|
@@ -2439,6 +2957,14 @@ declare class Sekyro {
|
|
|
2439
2957
|
* never returns the secret. An invalid key answers `401 unauthorized`.
|
|
2440
2958
|
*/
|
|
2441
2959
|
me(): Promise<ApiKeyIdentity>;
|
|
2960
|
+
/**
|
|
2961
|
+
* `GET /readiness`: what Live would change for your integration, from the
|
|
2962
|
+
* key environment's sessions of the last 30 days (counts and ids only). With
|
|
2963
|
+
* a Sandbox key it shows what Live would have stopped, so CI can assert
|
|
2964
|
+
* readiness before go-live; with a Live key it reports on Live. Needs the
|
|
2965
|
+
* `sessions:read` scope.
|
|
2966
|
+
*/
|
|
2967
|
+
readiness(): Promise<ReadinessReport>;
|
|
2442
2968
|
}
|
|
2443
2969
|
|
|
2444
|
-
export { type FlowSummary as $, type AgeMethod as A, type Block as B, type CreatedSession as C, type
|
|
2970
|
+
export { type FlowSummary as $, type AgeMethod as A, type Block as B, type CreatedSession as C, type ConnectorIdentity as D, type CreateBlockInput as E, type FetchLike as F, type CreateSessionInput as G, DEFAULT_BASE_URL as H, DEFAULT_TIMEOUT_MS as I, type DecisionReason as J, type DeepPartial as K, type Locale as L, type DeletedPerson as M, type DeliverOptions as N, type Device as O, DevicesApi as P, type DocumentSubstitutionSettings as Q, type ReviewReason as R, type SessionReason as S, type EidResult as T, type EligibilityReason as U, type VerificationLevel as V, type WebhookEventType as W, type ExtendLinkInput as X, type FlowOverridableSettings as Y, type FlowOverrides as Z, type FlowServiceSettings as _, Sekyro as a, type SessionEventDataBase as a$, FlowsApi as a0, type IdNumberReason as a1, type Identity as a2, type IdentityBirthPlace as a3, type IdentityDocument as a4, type IdentityIdNumber as a5, type IdentityMethod as a6, type IdentityName as a7, type IdentityScalarKey as a8, type IdentitySource as a9, type PersonSuspiciousActivityEventData as aA, type PersonUpdatedEventData as aB, type PortraitReportEntry as aC, type PriorReviewReason as aD, type ProbeBindingReason as aE, type ProbeQuality as aF, type ProfileDocumentType as aG, type ReadinessProtection as aH, type ReadinessReport as aI, type RequestOptions as aJ, type ResultTokenResponse as aK, type ReviewOutcomeReason as aL, type RevokePersonInput as aM, type ScreenPersonInput as aN, type Screening as aO, type ScreeningHit as aP, type ScreeningHitSummary as aQ, type ScreeningList as aR, type ScreeningStatus as aS, type ScreeningTrigger as aT, type ScreeningUnavailableReason as aU, type SekyroOptions as aV, SekyroTestApi as aW, type Session as aX, type SessionClosedEventDataBase as aY, type SessionDecidingStep as aZ, type SessionDevice as a_, type IdentitySources as aa, type LevelTarget as ab, type LiftBlockInput as ac, type ListBlocksQuery as ad, type ListPeopleQuery as ae, type ListScreeningsQuery as af, type ListSessionsQuery as ag, type ListSignalsQuery as ah, type MatchReason as ai, type MediaBytes as aj, type MediaBytesOptions as ak, type MediaItem as al, type MediaKind as am, type MediaList as an, type NameForm as ao, type Page as ap, PeopleApi as aq, type Person as ar, type PersonBirthPlaceInput as as, type PersonDeletedEventData as at, type PersonDocumentInput as au, type PersonEnrolledEventData as av, type PersonRef as aw, type PersonSession as ax, type PersonSessionInput as ay, type PersonSessionTarget as az, type ServiceId as b, type SessionEventStep as b0, type SessionFailureReason as b1, type SessionFlowRef as b2, type SessionHandoff as b3, type SessionHandoffDevice as b4, type SessionLifecycleEventData as b5, type SessionLinkDelivery as b6, type SessionLinkExpiry as b7, type SessionLinkInput as b8, type SessionNetwork as b9, type SubjectAssurance as bA, type SubjectIdNumber as bB, type SubjectName as bC, type SubjectReferenceSource as bD, type SubjectReuseTarget as bE, type SubjectStatus as bF, type UpdateSignalInput as bG, type UsageThresholdReachedEventData as bH, type VerifiedContacts as bI, type WebhookEnvelopeOf as bJ, type WebhookEventDataMap as bK, type WebhookTestInput as bL, type WebhookTestResult as bM, WebhooksApi as bN, type SessionNetworkEvent as ba, type SessionNotVerifiedEventData as bb, type SessionRetakeRequestedEventData as bc, type SessionReviewPendingEventData as bd, type SessionScreening as be, type SessionStatus as bf, type SessionStep as bg, type SessionStepAttempts as bh, type SessionStepBand as bi, type SessionStepDecision as bj, type SessionStepDocument as bk, type SessionStepPortrait as bl, SessionTestApi as bm, type SessionVerifiedEventData as bn, SessionsApi as bo, type Signal as bp, type SignalEventData as bq, type SignalEvidence as br, type SignalGrade as bs, type SignalKeyKind as bt, type SignalKind as bu, type SignalSeverity as bv, type SignalStatus as bw, SignalsApi as bx, type SimulateSessionInput as by, type StepResult as bz, type SessionPersonInput as c, type WebhookEnvelope as d, type SekyroEnvironment as e, type VerificationAssurance as f, type VerificationUnit as g, type SubjectReuseMode as h, type ResultCheckProofs as i, type SessionSignal as j, type FailureIdentification as k, type AgeResult as l, type AmlMatchFlaggedEventData as m, type ApiKeyIdentity as n, type BlockCheck as o, type BlockCheckInput as p, type BlockDuration as q, type BlockIdNumber as r, type BlockKind as s, type BlockMatch as t, type BlockReason as u, BlocksApi as v, type CameraUnavailableCause as w, type CheckState as x, type CheckType as y, type ClosedBy as z };
|