@sekyro/node 1.0.0-rc.28 → 1.0.0-rc.30
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 +14 -0
- package/README.md +50 -2
- package/dist/{client-D6zMa7hQ.d.cts → client-B2Xb076b.d.cts} +362 -6
- package/dist/{client-D6zMa7hQ.d.ts → client-B2Xb076b.d.ts} +362 -6
- 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-C66zNvN7.d.cts → connector-CMl114Xe.d.cts} +1 -1
- package/dist/{connector-D26UF7LX.d.ts → connector-GvdGGmUe.d.ts} +1 -1
- 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,19 @@
|
|
|
1
1
|
# @sekyro/node
|
|
2
2
|
|
|
3
|
+
## 1.0.0-rc.30
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 4654c5d: Decide sessions in review from your own review tool. `sekyro.reviews.list()` (with `listPage` and `iterate`) lists the sessions waiting on a decision, oldest first, and `sekyro.sessions.review(id, { outcome, reasons, reviewerRef }, { idempotencyKey })` decides one: `pass`, `fail` or `retake`. They need a key with the `reviews:read` and `reviews:decide` scopes. A step's `decision` now carries `via` (`dashboard`, `api` or `sekyro`) and, for an API decision, `reviewerRef`. New types: `ReviewQueueItem`, `ReviewQueueCheck`, `ReviewDecisionInput`, `ReviewOutcome`, `RetakeHint`, `ReviewVia`, `ListReviewsQuery`.
|
|
8
|
+
|
|
9
|
+
## 1.0.0-rc.29
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- 4729aa6: Your own AML screening lists. `sekyro.screeningLists` creates, reads, updates and deletes the lists of the key's environment (`create`, `list`, `get`, `update`, `delete`), and `sekyro.screeningLists.entries` writes and reads their entries (`upsert` of up to 1000 entries, `list`, `listPage`, `iterate`, `get`, `delete`, `deleteByReference`). Every AML screening step searches your active lists next to the public lists; the `aml_screening` flow settings take `excludeClientLists` to leave lists out. The key needs the `screening_lists:read` and `screening_lists:write` scopes, which you choose when you create it. New types: `ScreeningListsApi`, `ScreeningListEntriesApi`, `ClientScreeningList`, `ClientScreeningListEntry`, `ClientScreeningListEntryInput`, `ClientScreeningListIdNumber`, `ClientScreeningListEntriesWrite`, `ClientScreeningListEntryErrorCode`, `CreateScreeningListInput`, `UpdateScreeningListInput`, `ListScreeningListEntriesQuery`, `ScreeningListStrictness`, `DeletedScreeningListItem`.
|
|
14
|
+
|
|
15
|
+
A screening hit now says where it comes from: `ScreeningHitSummary.source` is `public` or `client` (absent on hits recorded before your own lists, which are public), and a hit of your own list carries its `listId`, `entryId` and your `reference`. `ScreeningList` gains `client`, which appears in `listsCovered` and on the hits of your lists.
|
|
16
|
+
|
|
3
17
|
## 1.0.0-rc.28
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -545,6 +545,32 @@ await sekyro.devices.update(deviceId, { shared: true }); // a shared device nee
|
|
|
545
545
|
`blocks.create` with `kind: "person"` answers a list, one block per ID number.
|
|
546
546
|
A shared device answers `409 device_shared` unless you pass `force: true`.
|
|
547
547
|
|
|
548
|
+
## Screening lists
|
|
549
|
+
|
|
550
|
+
`sekyro.screeningLists` manages your organization's own AML screening lists in
|
|
551
|
+
the key's environment. Every AML screening step searches every active list
|
|
552
|
+
next to the public lists, unless its flow leaves the list out. A hit of one of
|
|
553
|
+
your lists has `source: "client"`, `lists: ["client"]` and the `listId`,
|
|
554
|
+
`entryId` and `reference` of the entry. The key needs the
|
|
555
|
+
`screening_lists:read` or `screening_lists:write` scope, which a dashboard key
|
|
556
|
+
carries only when you ask for it at mint. See
|
|
557
|
+
[AML screening](https://docs.sekyro.ai/en/checks/aml-screening#your-own-lists).
|
|
558
|
+
|
|
559
|
+
```ts
|
|
560
|
+
const list = await sekyro.screeningLists.create({ name: "<list name>", strictness: "standard" });
|
|
561
|
+
const { created, updated, errors } = await sekyro.screeningLists.entries.upsert(list.id, [
|
|
562
|
+
{ reference: "<your reference>", names: ["<full name>"], birthDate: "<YYYY-MM-DD>", nationalities: ["<country code>"] },
|
|
563
|
+
]);
|
|
564
|
+
for await (const e of sekyro.screeningLists.entries.iterate(list.id)) e.names; // oldest first
|
|
565
|
+
await sekyro.screeningLists.entries.deleteByReference(list.id, "<your reference>");
|
|
566
|
+
await sekyro.screeningLists.update(list.id, { active: false });
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
`entries.upsert` writes 1 to 1000 entries. An entry with a `reference` the
|
|
570
|
+
list holds replaces it. Each entry is checked on its own: a refused one is in
|
|
571
|
+
`errors` with its position and a code (`bad_birth_date`, `bad_country`, ...),
|
|
572
|
+
and the others are written.
|
|
573
|
+
|
|
548
574
|
## Webhooks
|
|
549
575
|
|
|
550
576
|
Verify with the **raw** request body (bytes as received, before any JSON
|
|
@@ -626,7 +652,7 @@ When a person decides a step, the step carries `decision`
|
|
|
626
652
|
(`SessionStepDecision`) on `sekyro.sessions.get` and on the `steps` of the
|
|
627
653
|
`session.*` webhooks, and `session.verified` / `session.not_verified` carry it at the
|
|
628
654
|
top level with `closedBy: 'reviewer'`:
|
|
629
|
-
`{ source, mode, votes, agreement?, reasons, decidedAt, sessionId? }`.
|
|
655
|
+
`{ source, mode, votes, agreement?, reasons, decidedAt, sessionId?, via?, reviewerRef? }`.
|
|
630
656
|
`source` is `review` (a reviewer) or `prior_review` (an earlier approval of the
|
|
631
657
|
same person, reference photo and face was reused; `sessionId` names your
|
|
632
658
|
earlier session). Only approvals are reused: after an earlier rejection, the new
|
|
@@ -634,7 +660,29 @@ session goes through the checks and, when it needs one, to review again. `mode`
|
|
|
634
660
|
formed it and `agreement` says whether two dual reviewers agreed. `reasons`
|
|
635
661
|
(`ReviewReason[]`: `document_authenticity`, `liveness`, `face_match`,
|
|
636
662
|
`data_mismatch`, `screening`, `org_rule`, `other`) says what failed on a rejection, or what was
|
|
637
|
-
overridden on an approval.
|
|
663
|
+
overridden on an approval. `via` says how the deciding decision came in:
|
|
664
|
+
`dashboard`, `api` or `sekyro` (the Sekyro AI review service). An `api` decision
|
|
665
|
+
also carries the `reviewerRef` your system sent. The object never names a
|
|
666
|
+
member of your team or a vote.
|
|
667
|
+
|
|
668
|
+
Your own review tool can decide instead of the dashboard, with a key that has
|
|
669
|
+
the `reviews:read` and `reviews:decide` scopes:
|
|
670
|
+
|
|
671
|
+
```ts
|
|
672
|
+
for await (const r of sekyro.reviews.iterate()) {
|
|
673
|
+
const session = await sekyro.sessions.get(r.sessionId);
|
|
674
|
+
// ...your reviewer looks at the session and its media...
|
|
675
|
+
await sekyro.sessions.review(
|
|
676
|
+
r.sessionId,
|
|
677
|
+
{ outcome: "pass", reasons: ["liveness"], reviewerRef: "<your reviewer id>" },
|
|
678
|
+
{ idempotencyKey: "<one key per decision>" },
|
|
679
|
+
);
|
|
680
|
+
}
|
|
681
|
+
```
|
|
682
|
+
|
|
683
|
+
`reviewerRef` is your id for the person who decided, never an email address or a
|
|
684
|
+
phone number. With two reviewers, two decisions count as two only with two
|
|
685
|
+
different `reviewerRef` values.
|
|
638
686
|
|
|
639
687
|
A review that reaches its deadline ends with `session.not_verified`, `reason:
|
|
640
688
|
'inconclusive'`, `closedBy: 'deadline'` and `reasonCode: 'review_timeout'`, or
|
|
@@ -439,6 +439,112 @@ interface SessionStepDecision {
|
|
|
439
439
|
decidedAt: string;
|
|
440
440
|
/** `prior_review` only: your earlier session whose review decided this one. */
|
|
441
441
|
sessionId?: string;
|
|
442
|
+
/** How the deciding decision came in ({@link ReviewVia}). */
|
|
443
|
+
via?: ReviewVia;
|
|
444
|
+
/** `via: "api"` only: the `reviewerRef` your system sent with the decision. */
|
|
445
|
+
reviewerRef?: string;
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* How a review decision came in: `dashboard` (your team in the dashboard),
|
|
449
|
+
* `api` (your system, with {@link SessionsApi.review}) or `sekyro` (the Sekyro
|
|
450
|
+
* AI review service).
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
type ReviewVia = "dashboard" | "api" | "sekyro";
|
|
454
|
+
/**
|
|
455
|
+
* A review decision: `pass` and `fail` decide the check in review, `retake`
|
|
456
|
+
* sends the step back to the person for a new capture.
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
type ReviewOutcome = "pass" | "fail" | "retake";
|
|
460
|
+
/**
|
|
461
|
+
* What a retake may name besides a {@link ReviewReason}: the capture hint
|
|
462
|
+
* shown to the person on the new try.
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
type RetakeHint = "appearance" | "motion" | "lighting" | "framing";
|
|
466
|
+
/**
|
|
467
|
+
* The body of {@link SessionsApi.review}. `reasons`: on a fail, what failed; on
|
|
468
|
+
* a pass, the check you override (it must be in review); a retake may also
|
|
469
|
+
* name a {@link RetakeHint}. `other` alone needs `reasonText`.
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
type ReviewDecisionInput = {
|
|
473
|
+
outcome: "pass" | "fail";
|
|
474
|
+
reasons: readonly ReviewReason[];
|
|
475
|
+
reasonText?: string;
|
|
476
|
+
/** The {@link ReviewQueueCheck.checkIndex} you decide. Leave it out for the check in review now. */
|
|
477
|
+
checkIndex?: number;
|
|
478
|
+
/**
|
|
479
|
+
* Your own id for the person who decided: 1 to 128 letters, digits, `.`,
|
|
480
|
+
* `_`, `:` or `-`. Never an email address or a phone number
|
|
481
|
+
* (`400 reviewer_ref_invalid`). Two decisions with the same value are one
|
|
482
|
+
* reviewer in two-reviewer mode.
|
|
483
|
+
*/
|
|
484
|
+
reviewerRef: string;
|
|
485
|
+
} | {
|
|
486
|
+
outcome: "retake";
|
|
487
|
+
reasons: ReadonlyArray<ReviewReason | RetakeHint>;
|
|
488
|
+
reasonText?: string;
|
|
489
|
+
checkIndex?: number;
|
|
490
|
+
reviewerRef: string;
|
|
491
|
+
};
|
|
492
|
+
/**
|
|
493
|
+
* A check of a {@link ReviewQueueItem} that waits on a person.
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
interface ReviewQueueCheck {
|
|
497
|
+
/** Send it as {@link ReviewDecisionInput} `checkIndex`. */
|
|
498
|
+
checkIndex: number;
|
|
499
|
+
/** The step id, as in {@link SessionStep.id}. */
|
|
500
|
+
step?: string;
|
|
501
|
+
/** The service of the step, as in {@link SessionStep.service}. */
|
|
502
|
+
check?: string;
|
|
503
|
+
/** Liveness and face match: the band the score was decided on. */
|
|
504
|
+
band?: {
|
|
505
|
+
failBelow: number;
|
|
506
|
+
passAtOrAbove: number;
|
|
507
|
+
};
|
|
508
|
+
}
|
|
509
|
+
/**
|
|
510
|
+
* A session waiting on a review decision, from {@link ReviewsApi.list}. Ids,
|
|
511
|
+
* times and counts only: read the evidence with {@link SessionsApi.get} and
|
|
512
|
+
* {@link SessionsApi.media}.
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
interface ReviewQueueItem {
|
|
516
|
+
sessionId: string;
|
|
517
|
+
/** ISO 8601. */
|
|
518
|
+
createdAt: string;
|
|
519
|
+
/** ISO 8601: when the session went to review. */
|
|
520
|
+
reviewPendingAt: string;
|
|
521
|
+
/** ISO 8601: when the review deadline rejects it if nobody decides. */
|
|
522
|
+
deadlineAt: string;
|
|
523
|
+
/** How many reviewers must decide (your review setting). */
|
|
524
|
+
reviewersRequired: 1 | 2;
|
|
525
|
+
/** Two reviewers only: the decisions already in, oldest first, without their outcome (the next reviewer decides blind). */
|
|
526
|
+
decisions: Array<{
|
|
527
|
+
via: ReviewVia;
|
|
528
|
+
decidedAt: string;
|
|
529
|
+
}>;
|
|
530
|
+
/** `held` while a reviewer in the dashboard has the review open, `until` when that ends. */
|
|
531
|
+
lock: {
|
|
532
|
+
held: boolean;
|
|
533
|
+
until?: string;
|
|
534
|
+
};
|
|
535
|
+
/** The checks in review. */
|
|
536
|
+
checks: ReviewQueueCheck[];
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* Paging of {@link ReviewsApi.list}, {@link ReviewsApi.listPage} and
|
|
540
|
+
* {@link ReviewsApi.iterate}. Oldest review first.
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
interface ListReviewsQuery {
|
|
544
|
+
/** Page size, 1 to 100 (the API's default is 50). */
|
|
545
|
+
limit?: number;
|
|
546
|
+
/** The {@link Page.nextCursor} of the previous page. */
|
|
547
|
+
cursor?: string;
|
|
442
548
|
}
|
|
443
549
|
/**
|
|
444
550
|
* A failure identification match (terminal sessions, when the flow's
|
|
@@ -1027,6 +1133,8 @@ interface FlowServiceSettings {
|
|
|
1027
1133
|
aml_screening: {
|
|
1028
1134
|
lists: ScreeningList[];
|
|
1029
1135
|
onHit: "signal" | "review" | "fail";
|
|
1136
|
+
/** `scl_` ids of lists this step does not search; absent = every active list. */
|
|
1137
|
+
excludeClientLists?: string[];
|
|
1030
1138
|
};
|
|
1031
1139
|
face_dedup: {
|
|
1032
1140
|
scope: "app" | "org";
|
|
@@ -2613,8 +2721,14 @@ interface DeletedPerson {
|
|
|
2613
2721
|
id: string;
|
|
2614
2722
|
deleted: true;
|
|
2615
2723
|
}
|
|
2616
|
-
/**
|
|
2617
|
-
|
|
2724
|
+
/**
|
|
2725
|
+
* The lists an AML screening can search. `client` stands for your own
|
|
2726
|
+
* screening lists ({@link ScreeningListsApi}): it appears in `listsCovered`
|
|
2727
|
+
* and on hits, and is never asked for, since every screening step searches
|
|
2728
|
+
* your active lists unless its flow leaves them out.
|
|
2729
|
+
* @public
|
|
2730
|
+
*/
|
|
2731
|
+
type ScreeningList = "sanctions" | "pep" | "adverse_media" | "client";
|
|
2618
2732
|
/**
|
|
2619
2733
|
* Where a screening stands: `clear` (nothing scored above the possible
|
|
2620
2734
|
* threshold), `possible` (a possible match), `hit` (a match), `confirmed` or
|
|
@@ -2627,16 +2741,37 @@ type ScreeningStatus = "clear" | "possible" | "hit" | "confirmed" | "dismissed"
|
|
|
2627
2741
|
type ScreeningUnavailableReason = "screening_unavailable" | "no_identity_data" | "no_list_covered";
|
|
2628
2742
|
/** What ran a screening: a session step, a screening run again, or ongoing screening. @public */
|
|
2629
2743
|
type ScreeningTrigger = "session" | "rescreen" | "monitor";
|
|
2630
|
-
/**
|
|
2744
|
+
/**
|
|
2745
|
+
* A list entry that matched the person, best first: public list data
|
|
2746
|
+
* (`source: "public"`), or an entry of one of your own screening lists
|
|
2747
|
+
* (`source: "client"`, with `listId`, `entryId` and your `reference`).
|
|
2748
|
+
* @public
|
|
2749
|
+
*/
|
|
2631
2750
|
interface ScreeningHitSummary {
|
|
2632
|
-
/** The stable id of the list entry. */
|
|
2751
|
+
/** The stable id of the list entry (`sle_...` for an entry of your lists). */
|
|
2633
2752
|
entityId: string;
|
|
2634
|
-
/** The name of the entry as the list publishes it. */
|
|
2753
|
+
/** The name of the entry as the list publishes it, or the first name of your entry. */
|
|
2635
2754
|
caption: string;
|
|
2636
2755
|
/** How closely the entry matches the person, 0 to 1. */
|
|
2637
2756
|
score: number;
|
|
2638
2757
|
/** The searched lists the entry is on. */
|
|
2639
2758
|
lists: ScreeningList[];
|
|
2759
|
+
/**
|
|
2760
|
+
* Where the entry comes from: the public lists or your own screening lists.
|
|
2761
|
+
* Absent means public (hits recorded before client lists).
|
|
2762
|
+
*/
|
|
2763
|
+
source?: "public" | "client";
|
|
2764
|
+
/**
|
|
2765
|
+
* How the hit counts: `hit` is a match, `possible` a near match to check. Absent on hits
|
|
2766
|
+
* recorded before client lists (read the score against the screening status instead).
|
|
2767
|
+
*/
|
|
2768
|
+
level?: "hit" | "possible";
|
|
2769
|
+
/** `source: "client"`: the list (`scl_...`). */
|
|
2770
|
+
listId?: string;
|
|
2771
|
+
/** `source: "client"`: the entry (`sle_...`). */
|
|
2772
|
+
entryId?: string;
|
|
2773
|
+
/** `source: "client"`: your own id of the entry, when you gave one. */
|
|
2774
|
+
reference?: string;
|
|
2640
2775
|
}
|
|
2641
2776
|
/** A list entry that matched, with its public attributes and sources. @public */
|
|
2642
2777
|
interface ScreeningHit extends ScreeningHitSummary {
|
|
@@ -2737,6 +2872,120 @@ interface AmlMatchFlaggedEventData {
|
|
|
2737
2872
|
topScore: number;
|
|
2738
2873
|
hits: ScreeningHitSummary[];
|
|
2739
2874
|
}
|
|
2875
|
+
/**
|
|
2876
|
+
* How close a name must be to match an entry of a screening list: `exact`
|
|
2877
|
+
* (near-identical names only), `standard` (the closeness used for the public
|
|
2878
|
+
* lists) or `broad` (looser names, more matches to review). A matching ID
|
|
2879
|
+
* number is a hit at every strictness.
|
|
2880
|
+
* @public
|
|
2881
|
+
*/
|
|
2882
|
+
type ScreeningListStrictness = "exact" | "standard" | "broad";
|
|
2883
|
+
/**
|
|
2884
|
+
* One of your organization's own screening lists in this environment
|
|
2885
|
+
* ({@link ScreeningListsApi}). Every AML screening step searches every active
|
|
2886
|
+
* list unless its flow leaves the list out.
|
|
2887
|
+
* @public
|
|
2888
|
+
*/
|
|
2889
|
+
interface ClientScreeningList {
|
|
2890
|
+
/** The list id (`scl_...`). */
|
|
2891
|
+
id: string;
|
|
2892
|
+
/** Your name for the list, unique in this environment. */
|
|
2893
|
+
name: string;
|
|
2894
|
+
description?: string;
|
|
2895
|
+
strictness: ScreeningListStrictness;
|
|
2896
|
+
/** Whether screening steps search the list. */
|
|
2897
|
+
active: boolean;
|
|
2898
|
+
/** How many entries the list holds. */
|
|
2899
|
+
entryCount: number;
|
|
2900
|
+
/** ISO 8601. */
|
|
2901
|
+
createdAt: string;
|
|
2902
|
+
/** ISO 8601. */
|
|
2903
|
+
updatedAt: string;
|
|
2904
|
+
}
|
|
2905
|
+
/** Input of {@link ScreeningListsApi.create}. @public */
|
|
2906
|
+
interface CreateScreeningListInput {
|
|
2907
|
+
/** 1 to 80 characters, unique in this environment. */
|
|
2908
|
+
name: string;
|
|
2909
|
+
/** At most 500 characters. */
|
|
2910
|
+
description?: string;
|
|
2911
|
+
/** Default `standard`. */
|
|
2912
|
+
strictness?: ScreeningListStrictness;
|
|
2913
|
+
/** Default `true`. */
|
|
2914
|
+
active?: boolean;
|
|
2915
|
+
}
|
|
2916
|
+
/** Input of {@link ScreeningListsApi.update}: at least one field; `description: ""` clears it. @public */
|
|
2917
|
+
type UpdateScreeningListInput = Partial<CreateScreeningListInput>;
|
|
2918
|
+
/** An ID number of a screening list entry. @public */
|
|
2919
|
+
interface ClientScreeningListIdNumber {
|
|
2920
|
+
/** The number, as on the document (at most 64 characters). */
|
|
2921
|
+
value: string;
|
|
2922
|
+
/** ISO 3166-1 alpha-2 code of the issuing country. */
|
|
2923
|
+
country?: string;
|
|
2924
|
+
type?: "national_id" | "passport" | "residence_permit" | "drivers_license";
|
|
2925
|
+
}
|
|
2926
|
+
/** One entry as you write it ({@link ScreeningListsApi.entries}). @public */
|
|
2927
|
+
interface ClientScreeningListEntryInput {
|
|
2928
|
+
/**
|
|
2929
|
+
* Your own id for the entry, unique in the list (at most 128 characters).
|
|
2930
|
+
* Sending an entry with a reference the list holds replaces that entry.
|
|
2931
|
+
*/
|
|
2932
|
+
reference?: string;
|
|
2933
|
+
/** 1 to 20 names in any script, the full name first (each at most 200 characters). */
|
|
2934
|
+
names: string[];
|
|
2935
|
+
/** `YYYY`, `YYYY-MM` or `YYYY-MM-DD`. */
|
|
2936
|
+
birthDate?: string;
|
|
2937
|
+
/** ISO 3166-1 alpha-2 codes, at most 10. */
|
|
2938
|
+
nationalities?: string[];
|
|
2939
|
+
/** At most 10. */
|
|
2940
|
+
idNumbers?: ClientScreeningListIdNumber[];
|
|
2941
|
+
gender?: "male" | "female";
|
|
2942
|
+
/** Your note, at most 500 characters. */
|
|
2943
|
+
note?: string;
|
|
2944
|
+
}
|
|
2945
|
+
/** One entry of a screening list, with the data you wrote. @public */
|
|
2946
|
+
interface ClientScreeningListEntry extends ClientScreeningListEntryInput {
|
|
2947
|
+
/** The entry id (`sle_...`). */
|
|
2948
|
+
id: string;
|
|
2949
|
+
/** The list id (`scl_...`). */
|
|
2950
|
+
listId: string;
|
|
2951
|
+
/** ISO 8601. */
|
|
2952
|
+
addedAt: string;
|
|
2953
|
+
/** ISO 8601. */
|
|
2954
|
+
updatedAt: string;
|
|
2955
|
+
}
|
|
2956
|
+
/**
|
|
2957
|
+
* Why an entry was not written: `invalid_entry` (an unknown field or a wrong
|
|
2958
|
+
* type), `name_required`, `name_too_long`, `too_many_names`,
|
|
2959
|
+
* `too_many_id_numbers`, `too_many_nationalities`, `bad_id_number`, `bad_birth_date`, `bad_country`,
|
|
2960
|
+
* `bad_reference`, `note_too_long`, `duplicate_reference` (the same reference
|
|
2961
|
+
* twice in one call), `name_unmatchable` (no name of two letters or more and no
|
|
2962
|
+
* ID number: the entry could never match).
|
|
2963
|
+
* @public
|
|
2964
|
+
*/
|
|
2965
|
+
type ClientScreeningListEntryErrorCode = "invalid_entry" | "name_required" | "name_too_long" | "too_many_names" | "too_many_id_numbers" | "too_many_nationalities" | "bad_id_number" | "bad_birth_date" | "bad_country" | "bad_reference" | "note_too_long" | "duplicate_reference" | "name_unmatchable";
|
|
2966
|
+
/** Result of {@link ScreeningListEntriesApi.upsert}. @public */
|
|
2967
|
+
interface ClientScreeningListEntriesWrite {
|
|
2968
|
+
/** Entries added. */
|
|
2969
|
+
created: number;
|
|
2970
|
+
/** Entries replaced (their `reference` was already on the list). */
|
|
2971
|
+
updated: number;
|
|
2972
|
+
/** The entries not written, by their position in the call (from 0). */
|
|
2973
|
+
errors: Array<{
|
|
2974
|
+
index: number;
|
|
2975
|
+
code: ClientScreeningListEntryErrorCode;
|
|
2976
|
+
}>;
|
|
2977
|
+
}
|
|
2978
|
+
/** Query of {@link ScreeningListEntriesApi.list}. @public */
|
|
2979
|
+
interface ListScreeningListEntriesQuery {
|
|
2980
|
+
/** Page size, 1 to 100 (the API's default is 50). */
|
|
2981
|
+
limit?: number;
|
|
2982
|
+
/** The {@link Page.nextCursor} of the previous page. */
|
|
2983
|
+
cursor?: string;
|
|
2984
|
+
}
|
|
2985
|
+
/** Answer of the screening list deletes. @public */
|
|
2986
|
+
interface DeletedScreeningListItem {
|
|
2987
|
+
deleted: true;
|
|
2988
|
+
}
|
|
2740
2989
|
/** Options of {@link PeopleApi.revoke}. @public */
|
|
2741
2990
|
interface RevokePersonInput {
|
|
2742
2991
|
/** Kept on the audit trail only (≤ 500 characters). Do not put personal data here. */
|
|
@@ -2977,6 +3226,20 @@ declare class SessionsApi {
|
|
|
2977
3226
|
* ended (a repeated cancel included). Needs the `sessions:create` scope.
|
|
2978
3227
|
*/
|
|
2979
3228
|
cancel(id: string, opts?: RequestOptions): Promise<Session>;
|
|
3229
|
+
/**
|
|
3230
|
+
* `POST /sessions/:id/review`: decide a session in review from your own
|
|
3231
|
+
* review tool, as a reviewer in the dashboard would: `pass`, `fail` or
|
|
3232
|
+
* `retake`, with the reasons and the `reviewerRef` of the person who decided.
|
|
3233
|
+
* Two-reviewer mode, the deadline, the webhooks and the result token behave
|
|
3234
|
+
* as for a dashboard decision. Returns the session. Needs the
|
|
3235
|
+
* `reviews:decide` scope. `409 review_locked` while a reviewer in the
|
|
3236
|
+
* dashboard has it open (`details.lockedUntil`), `409 reviewer_already_decided`
|
|
3237
|
+
* when this `reviewerRef` already decided it, `409 review_by_sekyro` when
|
|
3238
|
+
* Sekyro AI reviews your Live sessions. The API requires an idempotency key:
|
|
3239
|
+
* one is generated when you pass none, so pass your own to make a retry of
|
|
3240
|
+
* the same decision safe.
|
|
3241
|
+
*/
|
|
3242
|
+
review(id: string, input: ReviewDecisionInput, opts?: RequestOptions): Promise<Session>;
|
|
2980
3243
|
/**
|
|
2981
3244
|
* `POST /sessions/:id/link/resend` — send the hosted link again through the
|
|
2982
3245
|
* session's own `deliver` channel, to the same destination (neither can be
|
|
@@ -3209,6 +3472,96 @@ declare class SignalsApi {
|
|
|
3209
3472
|
*/
|
|
3210
3473
|
update(id: string, input: UpdateSignalInput, opts?: RequestOptions): Promise<Signal>;
|
|
3211
3474
|
}
|
|
3475
|
+
/**
|
|
3476
|
+
* The entries of your screening lists. Exposed as
|
|
3477
|
+
* {@link ScreeningListsApi.entries}. Reading needs the `screening_lists:read`
|
|
3478
|
+
* scope, writing `screening_lists:write`. Exported as a TYPE only.
|
|
3479
|
+
* @public
|
|
3480
|
+
*/
|
|
3481
|
+
declare class ScreeningListEntriesApi {
|
|
3482
|
+
private readonly t;
|
|
3483
|
+
/** @internal */
|
|
3484
|
+
constructor(t: {
|
|
3485
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
3486
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
3487
|
+
});
|
|
3488
|
+
/**
|
|
3489
|
+
* `POST /screening-lists/:id/entries`: adds or updates 1 to 1000 entries.
|
|
3490
|
+
* An entry with a `reference` the list holds replaces it; one without is
|
|
3491
|
+
* always added. Each entry is checked on its own: a refused one is in
|
|
3492
|
+
* `errors` by its position and the others are written. The API requires an
|
|
3493
|
+
* idempotency key: one is generated when you pass none.
|
|
3494
|
+
*/
|
|
3495
|
+
upsert(listId: string, entries: ClientScreeningListEntryInput[], opts?: RequestOptions): Promise<ClientScreeningListEntriesWrite>;
|
|
3496
|
+
/** The first page of the entries of a list, oldest first. Every page: {@link ScreeningListEntriesApi.iterate}. */
|
|
3497
|
+
list(listId: string, query?: ListScreeningListEntriesQuery): Promise<ClientScreeningListEntry[]>;
|
|
3498
|
+
/** One page of {@link ScreeningListEntriesApi.list} with its `nextCursor` (absent on the last page). */
|
|
3499
|
+
listPage(listId: string, query?: ListScreeningListEntriesQuery): Promise<Page<ClientScreeningListEntry>>;
|
|
3500
|
+
/** Every entry of a list, oldest first, following `nextCursor` page after page. */
|
|
3501
|
+
iterate(listId: string, query?: ListScreeningListEntriesQuery): AsyncGenerator<ClientScreeningListEntry, void, undefined>;
|
|
3502
|
+
/** `GET /screening-lists/:id/entries/:entryId`: `404 screening_list_entry_not_found` when the list has no such entry. */
|
|
3503
|
+
get(listId: string, entryId: string): Promise<ClientScreeningListEntry>;
|
|
3504
|
+
/** `DELETE /screening-lists/:id/entries/:entryId`: removes one entry. */
|
|
3505
|
+
delete(listId: string, entryId: string): Promise<DeletedScreeningListItem>;
|
|
3506
|
+
/** `DELETE /screening-lists/:id/entries?reference=`: removes the entry with your `reference`. */
|
|
3507
|
+
deleteByReference(listId: string, reference: string): Promise<DeletedScreeningListItem>;
|
|
3508
|
+
}
|
|
3509
|
+
/**
|
|
3510
|
+
* Your organization's own screening lists in the key's environment: every AML
|
|
3511
|
+
* screening step searches every active list next to the public lists, unless
|
|
3512
|
+
* its flow leaves the list out. Exposed as {@link Sekyro.screeningLists}.
|
|
3513
|
+
* Reading needs the `screening_lists:read` scope, writing
|
|
3514
|
+
* `screening_lists:write`. Exported as a TYPE only.
|
|
3515
|
+
* @public
|
|
3516
|
+
*/
|
|
3517
|
+
declare class ScreeningListsApi {
|
|
3518
|
+
private readonly t;
|
|
3519
|
+
/** The entries of a list. */
|
|
3520
|
+
readonly entries: ScreeningListEntriesApi;
|
|
3521
|
+
/** @internal */
|
|
3522
|
+
constructor(t: {
|
|
3523
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
3524
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
3525
|
+
});
|
|
3526
|
+
/**
|
|
3527
|
+
* `POST /screening-lists`: creates a list. `409 screening_list_name_taken`
|
|
3528
|
+
* when the environment has a list of that name; `400 screening_list_limit`
|
|
3529
|
+
* past the organization's limit. The API requires an idempotency key: one
|
|
3530
|
+
* is generated when you pass none.
|
|
3531
|
+
*/
|
|
3532
|
+
create(input: CreateScreeningListInput, opts?: RequestOptions): Promise<ClientScreeningList>;
|
|
3533
|
+
/** `GET /screening-lists`: the lists of this environment, by name. */
|
|
3534
|
+
list(): Promise<ClientScreeningList[]>;
|
|
3535
|
+
/** `GET /screening-lists/:id`: `404 screening_list_not_found` for a list of another environment. */
|
|
3536
|
+
get(id: string): Promise<ClientScreeningList>;
|
|
3537
|
+
/**
|
|
3538
|
+
* `PATCH /screening-lists/:id`: renames a list or changes its description,
|
|
3539
|
+
* strictness or `active`; an empty `input` throws a `TypeError`. The API
|
|
3540
|
+
* requires an idempotency key: one is generated when you pass none.
|
|
3541
|
+
*/
|
|
3542
|
+
update(id: string, input: UpdateScreeningListInput, opts?: RequestOptions): Promise<ClientScreeningList>;
|
|
3543
|
+
/** `DELETE /screening-lists/:id`: deletes the list and all its entries. */
|
|
3544
|
+
delete(id: string): Promise<DeletedScreeningListItem>;
|
|
3545
|
+
}
|
|
3546
|
+
/**
|
|
3547
|
+
* The sessions waiting on a review decision ({@link ReviewQueueItem}), for your
|
|
3548
|
+
* own review tool. Exposed as {@link Sekyro.reviews}. Needs the `reviews:read`
|
|
3549
|
+
* scope; decide one with {@link SessionsApi.review}. Exported as a TYPE only.
|
|
3550
|
+
* @public
|
|
3551
|
+
*/
|
|
3552
|
+
declare class ReviewsApi {
|
|
3553
|
+
private readonly t;
|
|
3554
|
+
/** @internal */
|
|
3555
|
+
constructor(t: {
|
|
3556
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
3557
|
+
});
|
|
3558
|
+
/** The first page of the sessions in review (`GET /reviews`), oldest first. Every page: {@link ReviewsApi.iterate}. */
|
|
3559
|
+
list(query?: ListReviewsQuery): Promise<ReviewQueueItem[]>;
|
|
3560
|
+
/** One page of {@link ReviewsApi.list} with its `nextCursor` (absent on the last page). */
|
|
3561
|
+
listPage(query?: ListReviewsQuery): Promise<Page<ReviewQueueItem>>;
|
|
3562
|
+
/** Every session in review, oldest first, following `nextCursor` page after page. */
|
|
3563
|
+
iterate(query?: ListReviewsQuery): AsyncGenerator<ReviewQueueItem, void, undefined>;
|
|
3564
|
+
}
|
|
3212
3565
|
/**
|
|
3213
3566
|
* What you know about a device before you block it. Exposed as {@link Sekyro.devices}. Needs the
|
|
3214
3567
|
* `blocks:read` or `blocks:write` scope. Exported as a TYPE only.
|
|
@@ -3303,6 +3656,9 @@ declare class Sekyro {
|
|
|
3303
3656
|
readonly people: PeopleApi;
|
|
3304
3657
|
readonly blocks: BlocksApi;
|
|
3305
3658
|
readonly signals: SignalsApi;
|
|
3659
|
+
readonly screeningLists: ScreeningListsApi;
|
|
3660
|
+
/** The sessions in review: {@link ReviewsApi}. */
|
|
3661
|
+
readonly reviews: ReviewsApi;
|
|
3306
3662
|
readonly devices: DevicesApi;
|
|
3307
3663
|
readonly flows: FlowsApi;
|
|
3308
3664
|
readonly webhooks: WebhooksApi;
|
|
@@ -3325,4 +3681,4 @@ declare class Sekyro {
|
|
|
3325
3681
|
readiness(): Promise<ReadinessReport>;
|
|
3326
3682
|
}
|
|
3327
3683
|
|
|
3328
|
-
export { type
|
|
3684
|
+
export { type DeepPartial as $, type AgeMethod as A, type Block as B, type CreatedSession as C, type ClientScreeningListEntriesWrite as D, type ClientScreeningListEntry as E, type FetchLike as F, type ClientScreeningListEntryErrorCode as G, type ClientScreeningListEntryInput as H, type ClientScreeningListIdNumber as I, type ClosedBy as J, type ConnectorIdentity as K, type Locale as L, type CreateBlockInput as M, type CreateScreeningListInput as N, type CreateSessionInput as O, DEFAULT_BASE_URL as P, DEFAULT_TIMEOUT_MS as Q, type ReviewReason as R, type SessionReason as S, type DecisionReason as T, type Declared as U, type VerificationLevel as V, type WebhookEventType as W, type DeclaredAddress as X, type DeclaredAnswer as Y, type DeclaredConsent as Z, type DeclaredMismatch as _, Sekyro as a, type PoaRule as a$, type DeletedPerson as a0, type DeletedScreeningListItem as a1, type DeliverOptions as a2, type Device as a3, DevicesApi as a4, type DocumentSubstitutionSettings as a5, type EidResult as a6, type EligibilityReason as a7, type ExtendLinkInput as a8, type FlowOverridableSettings as a9, type ListScreeningListEntriesQuery as aA, type ListScreeningsQuery as aB, type ListSessionsQuery as aC, type ListSignalsQuery as aD, type MatchReason as aE, type MediaBytes as aF, type MediaBytesOptions as aG, type MediaItem as aH, type MediaKind as aI, type MediaList as aJ, type NameForm as aK, type OverridableServiceId as aL, type Page as aM, PeopleApi as aN, type Person as aO, type PersonAddressInput as aP, type PersonBirthPlaceInput as aQ, type PersonDeletedEventData as aR, type PersonDocumentInput as aS, type PersonEnrolledEventData as aT, type PersonRef as aU, type PersonSession as aV, type PersonSessionInput as aW, type PersonSessionTarget as aX, type PersonUpdatedEventData as aY, type PoaDocumentKind as aZ, type PoaReason as a_, type FlowOverrides as aa, type FlowServiceSettings as ab, type FlowSummary as ac, FlowsApi as ad, type FormAnswerValue as ae, type FormQuestionType as af, type FraudReason as ag, type FraudResponse as ah, type IdNumberReason as ai, type Identity as aj, type IdentityAddress as ak, type IdentityBirthPlace as al, type IdentityDocument as am, type IdentityIdNumber as an, type IdentityMethod as ao, type IdentityName as ap, type IdentityProofOfAddress as aq, type IdentityScalarKey as ar, type IdentitySource as as, type IdentitySources as at, type IncludedVerificationsThresholdReachedEventData as au, type LevelTarget as av, type LiftBlockInput as aw, type ListBlocksQuery as ax, type ListPeopleQuery as ay, type ListReviewsQuery as az, type ServiceId as b, type SessionVerifiedEventData as b$, type PoaRuleKind as b0, type PoaRules as b1, type PortraitReportEntry as b2, type PriorReviewReason as b3, type ProbeBindingReason as b4, type ProbeQuality as b5, type ProfileDocumentType as b6, type ReadinessProtection as b7, type ReadinessReport as b8, type RequestOptions as b9, type SessionClosedEventDataBase as bA, type SessionDecidingStep as bB, type SessionDevice as bC, type SessionEventDataBase as bD, type SessionEventStep as bE, type SessionFailureReason as bF, type SessionFlowRef as bG, type SessionHandoff as bH, type SessionHandoffDevice as bI, type SessionLifecycleEventData as bJ, type SessionLinkDelivery as bK, type SessionLinkExpiry as bL, type SessionLinkInput as bM, type SessionNetwork as bN, type SessionNetworkEvent as bO, type SessionNotVerifiedEventData as bP, type SessionRetakeRequestedEventData as bQ, type SessionReviewPendingEventData as bR, type SessionScreening as bS, type SessionStatus as bT, type SessionStep as bU, type SessionStepAttempts as bV, type SessionStepBand as bW, type SessionStepDecision as bX, type SessionStepDocument as bY, type SessionStepPortrait as bZ, SessionTestApi as b_, type ResultTokenResponse as ba, type RetakeHint as bb, type ReviewDecisionInput as bc, type ReviewOutcome as bd, type ReviewOutcomeReason as be, type ReviewQueueCheck as bf, type ReviewQueueItem as bg, type ReviewVia as bh, ReviewsApi as bi, type RevokePersonInput as bj, type SandboxSimulatedReason as bk, type SandboxSimulation as bl, type ScreenPersonInput as bm, type Screening as bn, type ScreeningHit as bo, type ScreeningHitSummary as bp, type ScreeningList as bq, ScreeningListEntriesApi as br, type ScreeningListStrictness as bs, ScreeningListsApi as bt, type ScreeningStatus as bu, type ScreeningTrigger as bv, type ScreeningUnavailableReason as bw, type SekyroOptions as bx, SekyroTestApi as by, type Session as bz, type SessionPersonInput as c, SessionsApi as c0, type Signal as c1, type SignalEventData as c2, type SignalEvidence as c3, type SignalGrade as c4, type SignalKeyKind as c5, type SignalKind as c6, type SignalSeverity as c7, type SignalStatus as c8, SignalsApi as c9, type SimulateSessionInput as ca, type StepResult as cb, type SubjectAssurance as cc, type SubjectIdNumber as cd, type SubjectName as ce, type SubjectReferenceSource as cf, type SubjectReuseTarget as cg, type SubjectStatus as ch, type UpdateScreeningListInput as ci, type UpdateSignalInput as cj, type UsageLimitReachedEventData as ck, type UsageThresholdReachedEventData as cl, type VerifiedContacts as cm, type WebhookEnvelopeOf as cn, type WebhookEventDataMap as co, type WebhookTestInput as cp, type WebhookTestResult as cq, WebhooksApi as cr, 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 ClientScreeningList as z };
|