@sekyro/node 1.0.0-rc.17 → 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 +22 -0
- package/README.md +43 -16
- package/dist/{client-DkpEJOBk.d.cts → client-B0zqD-HZ.d.cts} +199 -24
- package/dist/{client-DkpEJOBk.d.ts → client-B0zqD-HZ.d.ts} +199 -24
- package/dist/connect/express/index.d.cts +2 -2
- package/dist/connect/express/index.d.ts +2 -2
- package/dist/connect/index.d.cts +2 -2
- package/dist/connect/index.d.ts +2 -2
- package/dist/connect/next/index.d.cts +2 -2
- package/dist/connect/next/index.d.ts +2 -2
- package/dist/{connector-CiZVHNOR.d.ts → connector-CPyS23b7.d.ts} +2 -2
- package/dist/{connector-D97yp6iq.d.cts → connector-Cs-y1iL9.d.cts} +2 -2
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/sbom.cdx.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @sekyro/node
|
|
2
2
|
|
|
3
|
+
## 1.0.0-rc.18
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- db1d4d4: Breaking: the Sandbox speaks the Live contract, and the test tools live under `sekyro.test`.
|
|
8
|
+
|
|
9
|
+
Removed:
|
|
10
|
+
|
|
11
|
+
- `sekyro.sessions.simulate`: call `sekyro.test.sessions.simulate(id, input, opts)`.
|
|
12
|
+
- The `simulated` value of `CreatedSession.delivery.status` and `SessionLinkDelivery.delivery.status`: the status uses the Live values, and a Sandbox send that is not to an enrolled tester carries `simulated: true` instead.
|
|
13
|
+
|
|
14
|
+
Changed:
|
|
15
|
+
|
|
16
|
+
- `SimulateSessionInput` reaches every outcome of the session model: `status`, then optional `reason`, `closedBy`, `reasonCode`, `step` and `then` (`retake`, `decide:approve`, `decide:reject`, `binding_retake`). A pair the model cannot produce answers `422 simulate_pair_invalid`; a session a tester runs real checks in answers `409 session_bound`.
|
|
17
|
+
|
|
18
|
+
Added:
|
|
19
|
+
|
|
20
|
+
- `sekyro.webhooks.test({ event })`: sends a realistic sample of any event to the endpoints of the key's environment. Types `WebhooksApi`, `WebhookTestInput`, `WebhookTestResult`, `SekyroTestApi`, `SessionTestApi`.
|
|
21
|
+
- `sekyro.readiness()`: what Live would change for your integration, from the key environment's sessions of the last 30 days (`GET /readiness`), so CI can assert readiness. Types `ReadinessReport`, `ReadinessProtection`.
|
|
22
|
+
|
|
23
|
+
The connector snippets read `env` from your configuration (`SEKYRO_ENV`) instead of a literal.
|
|
24
|
+
|
|
3
25
|
## 1.0.0-rc.17
|
|
4
26
|
|
|
5
27
|
### Major Changes
|
package/README.md
CHANGED
|
@@ -197,30 +197,58 @@ for await (const s of sekyro.sessions.iterate({ externalRef: userId, status: "ve
|
|
|
197
197
|
### Test in the Sandbox
|
|
198
198
|
|
|
199
199
|
A `sk_test_…` key runs on the same API as a `sk_live_…` key; the key chooses the
|
|
200
|
-
environment. `sekyro.me()`
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
200
|
+
environment, and your production code runs unchanged with either. `sekyro.me()`
|
|
201
|
+
tells you which key you hold. The tools for tests and CI live under
|
|
202
|
+
`sekyro.test`, so they stay out of your production path:
|
|
203
|
+
`sekyro.test.sessions.simulate()` ends a simulated session with the outcome you
|
|
204
|
+
name, in one call. It runs the real engine (expiry, cancel, supersession,
|
|
205
|
+
reviewer decision), so the webhooks, the result token and the dashboard behave
|
|
206
|
+
as for a session driven by a person. It is never billed.
|
|
204
207
|
|
|
205
208
|
```ts
|
|
206
209
|
const me = await sekyro.me();
|
|
207
210
|
// { env: "sandbox", keyPrefix, scopes, app: { id, slug, name }, org: { name } }
|
|
208
211
|
|
|
209
212
|
const { id } = await sekyro.sessions.create({ person: { externalRef: "<your user id>" } });
|
|
210
|
-
const session = await sekyro.sessions.simulate(
|
|
213
|
+
const session = await sekyro.test.sessions.simulate(
|
|
211
214
|
id,
|
|
212
|
-
{ status: "not_verified",
|
|
215
|
+
{ status: "not_verified", reason: "rejected", reasonCode: "spoof_detected" },
|
|
213
216
|
{ idempotencyKey: "<your CI run id>" },
|
|
214
217
|
);
|
|
218
|
+
// Other outcomes: { status: "verified" }, { status: "not_verified", reason: "abandoned" },
|
|
219
|
+
// { status: "review_pending", then: "decide:approve" }, { status: "review_pending", then: "retake" }
|
|
215
220
|
```
|
|
216
221
|
|
|
217
|
-
`
|
|
218
|
-
the
|
|
219
|
-
`
|
|
220
|
-
`
|
|
221
|
-
`
|
|
222
|
-
|
|
223
|
-
|
|
222
|
+
`status` is required. `reason` and `closedBy` default to the pair the engine
|
|
223
|
+
produces for the path; `reasonCode` and `step` name the step that decides it;
|
|
224
|
+
`then` runs a follow-up: after `review_pending`, `decide:approve`,
|
|
225
|
+
`decide:reject` or `retake`; with `verified`, `binding_retake`. Errors:
|
|
226
|
+
`400 sandbox_only` (a Live key), `409 session_bound` (a tester runs real
|
|
227
|
+
checks in it), `409 session_already_final`,
|
|
228
|
+
`422 simulate_pair_invalid` (`details.validPairs` lists the valid pairs),
|
|
229
|
+
`422 simulate_status_unreachable` (`details.issues` says why) and
|
|
230
|
+
`422 simulate_reason_invalid`.
|
|
231
|
+
|
|
232
|
+
`sekyro.webhooks.test({ event })` sends a realistic sample of any event to the
|
|
233
|
+
endpoints of the key's environment, signed like a real delivery:
|
|
234
|
+
|
|
235
|
+
```ts
|
|
236
|
+
await sekyro.webhooks.test({ event: "session.verified" }); // { dispatched, endpoints }
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
`sekyro.readiness()` reports what Live would change for your integration, from
|
|
240
|
+
the last 30 days of the key environment's sessions: client protections Live
|
|
241
|
+
would enforce, webhook endpoints per environment and failed deliveries, registry
|
|
242
|
+
access per flow, Live rate limits against your peak, and the SDK versions your
|
|
243
|
+
sessions used. Assert on it in CI before you go live:
|
|
244
|
+
|
|
245
|
+
```ts
|
|
246
|
+
const report = await sekyro.readiness();
|
|
247
|
+
if (report.webhooks.endpoints.live === 0) throw new Error("no Live webhook endpoint");
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
See the [Sandbox guide](https://docs.sekyro.ai/en/getting-started/sandbox) and
|
|
251
|
+
[Test identities and outcomes](https://docs.sekyro.ai/en/getting-started/test-identities).
|
|
224
252
|
|
|
225
253
|
### Identity data and media
|
|
226
254
|
|
|
@@ -321,8 +349,7 @@ Partner-supplied identity data is not billed: the Partner-supplied identity step
|
|
|
321
349
|
records no usage event (other steps, such as the face match, bill as usual).
|
|
322
350
|
|
|
323
351
|
The step reasons and codes about the number are `registry_record_not_found`,
|
|
324
|
-
`id_number_invalid`, `id_number_locked
|
|
325
|
-
`sandbox_id_number_not_seeded`. See
|
|
352
|
+
`id_number_invalid`, `id_number_locked` and `document_id_number_mismatch`. See
|
|
326
353
|
[Person data](https://docs.sekyro.ai/en/guides/person-data).
|
|
327
354
|
|
|
328
355
|
### Errors
|
|
@@ -611,7 +638,7 @@ import { createConnector } from "@sekyro/node/connect";
|
|
|
611
638
|
const connector = createConnector({
|
|
612
639
|
sekyro: new Sekyro({ apiKey: process.env.SEKYRO_API_KEY! }),
|
|
613
640
|
appId: process.env.SEKYRO_APP_ID!, // or an array of app ids
|
|
614
|
-
env: "live",
|
|
641
|
+
env: process.env.SEKYRO_ENV as "sandbox" | "live", // "sandbox" with an sk_test_ key, "live" with an sk_live_ key
|
|
615
642
|
webhookSecret: process.env.SEKYRO_WEBHOOK_SECRET!,
|
|
616
643
|
provider, // from a provider package
|
|
617
644
|
onUserDeleted: "ignore", // 'ignore' | 'revoke' | 'delete'
|
|
@@ -1030,21 +1030,140 @@ interface SessionFlowRef {
|
|
|
1030
1030
|
version: number;
|
|
1031
1031
|
}
|
|
1032
1032
|
/**
|
|
1033
|
-
* 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.
|
|
1034
1037
|
* @public
|
|
1035
1038
|
*/
|
|
1036
1039
|
interface SimulateSessionInput {
|
|
1040
|
+
/** Where the session ends. */
|
|
1041
|
+
status: "verified" | "not_verified" | "review_pending";
|
|
1037
1042
|
/**
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
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`.
|
|
1040
1046
|
*/
|
|
1041
|
-
|
|
1047
|
+
reason?: SessionReason;
|
|
1048
|
+
/** Who closes the session. Defaults to the value the engine gives for the path. */
|
|
1049
|
+
closedBy?: ClosedBy;
|
|
1042
1050
|
/**
|
|
1043
|
-
*
|
|
1044
|
-
*
|
|
1045
|
-
* `422 simulate_reason_invalid`.
|
|
1051
|
+
* `not_verified` closed `automatic` only: the detailed code a step on the
|
|
1052
|
+
* path ends with, e.g. `spoof_detected` ({@link Session.reasonCode}).
|
|
1046
1053
|
*/
|
|
1047
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;
|
|
1048
1167
|
}
|
|
1049
1168
|
/**
|
|
1050
1169
|
* The API key in use, from {@link Sekyro.me}. Never carries the secret.
|
|
@@ -1179,10 +1298,13 @@ interface CreatedSession {
|
|
|
1179
1298
|
subjectUse?: "reference" | "prefill";
|
|
1180
1299
|
/**
|
|
1181
1300
|
* With {@link CreateSessionInput.deliver} only: the send of the hosted link.
|
|
1182
|
-
* `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.
|
|
1183
1304
|
*/
|
|
1184
1305
|
delivery?: {
|
|
1185
|
-
status: "queued" | "failed"
|
|
1306
|
+
status: "queued" | "failed";
|
|
1307
|
+
simulated?: true;
|
|
1186
1308
|
};
|
|
1187
1309
|
}
|
|
1188
1310
|
/**
|
|
@@ -2291,8 +2413,9 @@ type ExtendLinkInput = {
|
|
|
2291
2413
|
interface SessionLinkDelivery {
|
|
2292
2414
|
delivery: {
|
|
2293
2415
|
channel: "sms" | "whatsapp" | "email";
|
|
2294
|
-
|
|
2295
|
-
|
|
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;
|
|
2296
2419
|
};
|
|
2297
2420
|
}
|
|
2298
2421
|
/** Result of {@link SessionsApi.extendLink}. @public */
|
|
@@ -2557,18 +2680,6 @@ declare class SessionsApi {
|
|
|
2557
2680
|
* (it has no token). Needs the `sessions:read` scope.
|
|
2558
2681
|
*/
|
|
2559
2682
|
resultToken(id: string): Promise<ResultTokenResponse>;
|
|
2560
|
-
/**
|
|
2561
|
-
* `POST /sessions/:id/simulate`: finishes a simulated Sandbox session in one
|
|
2562
|
-
* call, for tests and CI. It runs every step of the flow through the real
|
|
2563
|
-
* engine, so the status, the webhooks, the result token and the dashboard
|
|
2564
|
-
* behave as for a session driven by a person. Never billed. Returns the
|
|
2565
|
-
* finished session; pass an `idempotencyKey` to make a retry safe. Errors:
|
|
2566
|
-
* `400 sandbox_only` (Live key), `409 session_not_simulated` (bound to a
|
|
2567
|
-
* tester), `409 session_already_final`, `422 simulate_status_unreachable`
|
|
2568
|
-
* (`details.issues` says why), `422 simulate_reason_invalid`. Needs the
|
|
2569
|
-
* `sessions:create` scope.
|
|
2570
|
-
*/
|
|
2571
|
-
simulate(id: string, input: SimulateSessionInput, opts?: RequestOptions): Promise<Session>;
|
|
2572
2683
|
}
|
|
2573
2684
|
/**
|
|
2574
2685
|
* `sekyro.flows`: the flows of the API key's app.
|
|
@@ -2761,6 +2872,59 @@ declare class DevicesApi {
|
|
|
2761
2872
|
shared: boolean;
|
|
2762
2873
|
}, opts?: RequestOptions): Promise<Device>;
|
|
2763
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
|
+
}
|
|
2764
2928
|
/**
|
|
2765
2929
|
* Sekyro AI partner API client. Server-side only: it carries your API key.
|
|
2766
2930
|
*
|
|
@@ -2783,6 +2947,9 @@ declare class Sekyro {
|
|
|
2783
2947
|
readonly signals: SignalsApi;
|
|
2784
2948
|
readonly devices: DevicesApi;
|
|
2785
2949
|
readonly flows: FlowsApi;
|
|
2950
|
+
readonly webhooks: WebhooksApi;
|
|
2951
|
+
/** Test tools for the Sandbox: {@link SekyroTestApi}. */
|
|
2952
|
+
readonly test: SekyroTestApi;
|
|
2786
2953
|
constructor(opts: SekyroOptions);
|
|
2787
2954
|
/**
|
|
2788
2955
|
* `GET /me`: which key this is. Tells a Sandbox key from a Live one, and
|
|
@@ -2790,6 +2957,14 @@ declare class Sekyro {
|
|
|
2790
2957
|
* never returns the secret. An invalid key answers `401 unauthorized`.
|
|
2791
2958
|
*/
|
|
2792
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>;
|
|
2793
2968
|
}
|
|
2794
2969
|
|
|
2795
|
-
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
|
|
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 };
|