@sekyro/node 1.0.0-rc.27 → 1.0.0-rc.29
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 +26 -0
- package/dist/{client-C6Hcqq_r.d.cts → client-B4wM-_Xp.d.cts} +226 -12
- package/dist/{client-C6Hcqq_r.d.ts → client-B4wM-_Xp.d.ts} +226 -12
- 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-Ca-nVhfj.d.cts → connector-CI50FjGZ.d.cts} +1 -1
- package/dist/{connector-DNcoLfcm.d.ts → connector-CR2FHfxc.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.29
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 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`.
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
## 1.0.0-rc.28
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- dfe2f1e: The doc comments of `blocks.create` and `signals` no longer list `403` errors the API does not answer: a block acts as soon as it exists, and Signals are available in every environment.
|
|
16
|
+
|
|
3
17
|
## 1.0.0-rc.27
|
|
4
18
|
|
|
5
19
|
### Minor 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
|
|
@@ -1027,6 +1027,8 @@ interface FlowServiceSettings {
|
|
|
1027
1027
|
aml_screening: {
|
|
1028
1028
|
lists: ScreeningList[];
|
|
1029
1029
|
onHit: "signal" | "review" | "fail";
|
|
1030
|
+
/** `scl_` ids of lists this step does not search; absent = every active list. */
|
|
1031
|
+
excludeClientLists?: string[];
|
|
1030
1032
|
};
|
|
1031
1033
|
face_dedup: {
|
|
1032
1034
|
scope: "app" | "org";
|
|
@@ -2613,8 +2615,14 @@ interface DeletedPerson {
|
|
|
2613
2615
|
id: string;
|
|
2614
2616
|
deleted: true;
|
|
2615
2617
|
}
|
|
2616
|
-
/**
|
|
2617
|
-
|
|
2618
|
+
/**
|
|
2619
|
+
* The lists an AML screening can search. `client` stands for your own
|
|
2620
|
+
* screening lists ({@link ScreeningListsApi}): it appears in `listsCovered`
|
|
2621
|
+
* and on hits, and is never asked for, since every screening step searches
|
|
2622
|
+
* your active lists unless its flow leaves them out.
|
|
2623
|
+
* @public
|
|
2624
|
+
*/
|
|
2625
|
+
type ScreeningList = "sanctions" | "pep" | "adverse_media" | "client";
|
|
2618
2626
|
/**
|
|
2619
2627
|
* Where a screening stands: `clear` (nothing scored above the possible
|
|
2620
2628
|
* threshold), `possible` (a possible match), `hit` (a match), `confirmed` or
|
|
@@ -2627,16 +2635,37 @@ type ScreeningStatus = "clear" | "possible" | "hit" | "confirmed" | "dismissed"
|
|
|
2627
2635
|
type ScreeningUnavailableReason = "screening_unavailable" | "no_identity_data" | "no_list_covered";
|
|
2628
2636
|
/** What ran a screening: a session step, a screening run again, or ongoing screening. @public */
|
|
2629
2637
|
type ScreeningTrigger = "session" | "rescreen" | "monitor";
|
|
2630
|
-
/**
|
|
2638
|
+
/**
|
|
2639
|
+
* A list entry that matched the person, best first: public list data
|
|
2640
|
+
* (`source: "public"`), or an entry of one of your own screening lists
|
|
2641
|
+
* (`source: "client"`, with `listId`, `entryId` and your `reference`).
|
|
2642
|
+
* @public
|
|
2643
|
+
*/
|
|
2631
2644
|
interface ScreeningHitSummary {
|
|
2632
|
-
/** The stable id of the list entry. */
|
|
2645
|
+
/** The stable id of the list entry (`sle_...` for an entry of your lists). */
|
|
2633
2646
|
entityId: string;
|
|
2634
|
-
/** The name of the entry as the list publishes it. */
|
|
2647
|
+
/** The name of the entry as the list publishes it, or the first name of your entry. */
|
|
2635
2648
|
caption: string;
|
|
2636
2649
|
/** How closely the entry matches the person, 0 to 1. */
|
|
2637
2650
|
score: number;
|
|
2638
2651
|
/** The searched lists the entry is on. */
|
|
2639
2652
|
lists: ScreeningList[];
|
|
2653
|
+
/**
|
|
2654
|
+
* Where the entry comes from: the public lists or your own screening lists.
|
|
2655
|
+
* Absent means public (hits recorded before client lists).
|
|
2656
|
+
*/
|
|
2657
|
+
source?: "public" | "client";
|
|
2658
|
+
/**
|
|
2659
|
+
* How the hit counts: `hit` is a match, `possible` a near match to check. Absent on hits
|
|
2660
|
+
* recorded before client lists (read the score against the screening status instead).
|
|
2661
|
+
*/
|
|
2662
|
+
level?: "hit" | "possible";
|
|
2663
|
+
/** `source: "client"`: the list (`scl_...`). */
|
|
2664
|
+
listId?: string;
|
|
2665
|
+
/** `source: "client"`: the entry (`sle_...`). */
|
|
2666
|
+
entryId?: string;
|
|
2667
|
+
/** `source: "client"`: your own id of the entry, when you gave one. */
|
|
2668
|
+
reference?: string;
|
|
2640
2669
|
}
|
|
2641
2670
|
/** A list entry that matched, with its public attributes and sources. @public */
|
|
2642
2671
|
interface ScreeningHit extends ScreeningHitSummary {
|
|
@@ -2737,6 +2766,120 @@ interface AmlMatchFlaggedEventData {
|
|
|
2737
2766
|
topScore: number;
|
|
2738
2767
|
hits: ScreeningHitSummary[];
|
|
2739
2768
|
}
|
|
2769
|
+
/**
|
|
2770
|
+
* How close a name must be to match an entry of a screening list: `exact`
|
|
2771
|
+
* (near-identical names only), `standard` (the closeness used for the public
|
|
2772
|
+
* lists) or `broad` (looser names, more matches to review). A matching ID
|
|
2773
|
+
* number is a hit at every strictness.
|
|
2774
|
+
* @public
|
|
2775
|
+
*/
|
|
2776
|
+
type ScreeningListStrictness = "exact" | "standard" | "broad";
|
|
2777
|
+
/**
|
|
2778
|
+
* One of your organization's own screening lists in this environment
|
|
2779
|
+
* ({@link ScreeningListsApi}). Every AML screening step searches every active
|
|
2780
|
+
* list unless its flow leaves the list out.
|
|
2781
|
+
* @public
|
|
2782
|
+
*/
|
|
2783
|
+
interface ClientScreeningList {
|
|
2784
|
+
/** The list id (`scl_...`). */
|
|
2785
|
+
id: string;
|
|
2786
|
+
/** Your name for the list, unique in this environment. */
|
|
2787
|
+
name: string;
|
|
2788
|
+
description?: string;
|
|
2789
|
+
strictness: ScreeningListStrictness;
|
|
2790
|
+
/** Whether screening steps search the list. */
|
|
2791
|
+
active: boolean;
|
|
2792
|
+
/** How many entries the list holds. */
|
|
2793
|
+
entryCount: number;
|
|
2794
|
+
/** ISO 8601. */
|
|
2795
|
+
createdAt: string;
|
|
2796
|
+
/** ISO 8601. */
|
|
2797
|
+
updatedAt: string;
|
|
2798
|
+
}
|
|
2799
|
+
/** Input of {@link ScreeningListsApi.create}. @public */
|
|
2800
|
+
interface CreateScreeningListInput {
|
|
2801
|
+
/** 1 to 80 characters, unique in this environment. */
|
|
2802
|
+
name: string;
|
|
2803
|
+
/** At most 500 characters. */
|
|
2804
|
+
description?: string;
|
|
2805
|
+
/** Default `standard`. */
|
|
2806
|
+
strictness?: ScreeningListStrictness;
|
|
2807
|
+
/** Default `true`. */
|
|
2808
|
+
active?: boolean;
|
|
2809
|
+
}
|
|
2810
|
+
/** Input of {@link ScreeningListsApi.update}: at least one field; `description: ""` clears it. @public */
|
|
2811
|
+
type UpdateScreeningListInput = Partial<CreateScreeningListInput>;
|
|
2812
|
+
/** An ID number of a screening list entry. @public */
|
|
2813
|
+
interface ClientScreeningListIdNumber {
|
|
2814
|
+
/** The number, as on the document (at most 64 characters). */
|
|
2815
|
+
value: string;
|
|
2816
|
+
/** ISO 3166-1 alpha-2 code of the issuing country. */
|
|
2817
|
+
country?: string;
|
|
2818
|
+
type?: "national_id" | "passport" | "residence_permit" | "drivers_license";
|
|
2819
|
+
}
|
|
2820
|
+
/** One entry as you write it ({@link ScreeningListsApi.entries}). @public */
|
|
2821
|
+
interface ClientScreeningListEntryInput {
|
|
2822
|
+
/**
|
|
2823
|
+
* Your own id for the entry, unique in the list (at most 128 characters).
|
|
2824
|
+
* Sending an entry with a reference the list holds replaces that entry.
|
|
2825
|
+
*/
|
|
2826
|
+
reference?: string;
|
|
2827
|
+
/** 1 to 20 names in any script, the full name first (each at most 200 characters). */
|
|
2828
|
+
names: string[];
|
|
2829
|
+
/** `YYYY`, `YYYY-MM` or `YYYY-MM-DD`. */
|
|
2830
|
+
birthDate?: string;
|
|
2831
|
+
/** ISO 3166-1 alpha-2 codes, at most 10. */
|
|
2832
|
+
nationalities?: string[];
|
|
2833
|
+
/** At most 10. */
|
|
2834
|
+
idNumbers?: ClientScreeningListIdNumber[];
|
|
2835
|
+
gender?: "male" | "female";
|
|
2836
|
+
/** Your note, at most 500 characters. */
|
|
2837
|
+
note?: string;
|
|
2838
|
+
}
|
|
2839
|
+
/** One entry of a screening list, with the data you wrote. @public */
|
|
2840
|
+
interface ClientScreeningListEntry extends ClientScreeningListEntryInput {
|
|
2841
|
+
/** The entry id (`sle_...`). */
|
|
2842
|
+
id: string;
|
|
2843
|
+
/** The list id (`scl_...`). */
|
|
2844
|
+
listId: string;
|
|
2845
|
+
/** ISO 8601. */
|
|
2846
|
+
addedAt: string;
|
|
2847
|
+
/** ISO 8601. */
|
|
2848
|
+
updatedAt: string;
|
|
2849
|
+
}
|
|
2850
|
+
/**
|
|
2851
|
+
* Why an entry was not written: `invalid_entry` (an unknown field or a wrong
|
|
2852
|
+
* type), `name_required`, `name_too_long`, `too_many_names`,
|
|
2853
|
+
* `too_many_id_numbers`, `too_many_nationalities`, `bad_id_number`, `bad_birth_date`, `bad_country`,
|
|
2854
|
+
* `bad_reference`, `note_too_long`, `duplicate_reference` (the same reference
|
|
2855
|
+
* twice in one call), `name_unmatchable` (no name of two letters or more and no
|
|
2856
|
+
* ID number: the entry could never match).
|
|
2857
|
+
* @public
|
|
2858
|
+
*/
|
|
2859
|
+
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";
|
|
2860
|
+
/** Result of {@link ScreeningListEntriesApi.upsert}. @public */
|
|
2861
|
+
interface ClientScreeningListEntriesWrite {
|
|
2862
|
+
/** Entries added. */
|
|
2863
|
+
created: number;
|
|
2864
|
+
/** Entries replaced (their `reference` was already on the list). */
|
|
2865
|
+
updated: number;
|
|
2866
|
+
/** The entries not written, by their position in the call (from 0). */
|
|
2867
|
+
errors: Array<{
|
|
2868
|
+
index: number;
|
|
2869
|
+
code: ClientScreeningListEntryErrorCode;
|
|
2870
|
+
}>;
|
|
2871
|
+
}
|
|
2872
|
+
/** Query of {@link ScreeningListEntriesApi.list}. @public */
|
|
2873
|
+
interface ListScreeningListEntriesQuery {
|
|
2874
|
+
/** Page size, 1 to 100 (the API's default is 50). */
|
|
2875
|
+
limit?: number;
|
|
2876
|
+
/** The {@link Page.nextCursor} of the previous page. */
|
|
2877
|
+
cursor?: string;
|
|
2878
|
+
}
|
|
2879
|
+
/** Answer of the screening list deletes. @public */
|
|
2880
|
+
interface DeletedScreeningListItem {
|
|
2881
|
+
deleted: true;
|
|
2882
|
+
}
|
|
2740
2883
|
/** Options of {@link PeopleApi.revoke}. @public */
|
|
2741
2884
|
interface RevokePersonInput {
|
|
2742
2885
|
/** Kept on the audit trail only (≤ 500 characters). Do not put personal data here. */
|
|
@@ -3157,9 +3300,9 @@ declare class BlocksApi {
|
|
|
3157
3300
|
/**
|
|
3158
3301
|
* `POST /blocks`: blocks the key, or answers the active block already on it. `kind: "person"`
|
|
3159
3302
|
* blocks each ID number of the person and answers a list. A shared device answers
|
|
3160
|
-
* `409 device_shared` with `details.people` unless `force: true`.
|
|
3161
|
-
*
|
|
3162
|
-
*
|
|
3303
|
+
* `409 device_shared` with `details.people` unless `force: true`. A block acts as soon as it
|
|
3304
|
+
* exists. The API requires an idempotency key: one is generated when you pass none, so pass your
|
|
3305
|
+
* own to make a retry of the same call safe.
|
|
3163
3306
|
*/
|
|
3164
3307
|
create(input: CreateBlockInput & {
|
|
3165
3308
|
kind: "person";
|
|
@@ -3181,9 +3324,8 @@ declare class BlocksApi {
|
|
|
3181
3324
|
/**
|
|
3182
3325
|
* Findings: sessions of this environment that share a key and met a pattern
|
|
3183
3326
|
* ({@link Signal}). Exposed as {@link Sekyro.signals}. Reading needs the
|
|
3184
|
-
* `signals:read` scope, {@link SignalsApi.update} `signals:write`.
|
|
3185
|
-
*
|
|
3186
|
-
* environment. Exported as a TYPE only.
|
|
3327
|
+
* `signals:read` scope, {@link SignalsApi.update} `signals:write`. Exported as
|
|
3328
|
+
* a TYPE only.
|
|
3187
3329
|
* @public
|
|
3188
3330
|
*/
|
|
3189
3331
|
declare class SignalsApi {
|
|
@@ -3210,6 +3352,77 @@ declare class SignalsApi {
|
|
|
3210
3352
|
*/
|
|
3211
3353
|
update(id: string, input: UpdateSignalInput, opts?: RequestOptions): Promise<Signal>;
|
|
3212
3354
|
}
|
|
3355
|
+
/**
|
|
3356
|
+
* The entries of your screening lists. Exposed as
|
|
3357
|
+
* {@link ScreeningListsApi.entries}. Reading needs the `screening_lists:read`
|
|
3358
|
+
* scope, writing `screening_lists:write`. Exported as a TYPE only.
|
|
3359
|
+
* @public
|
|
3360
|
+
*/
|
|
3361
|
+
declare class ScreeningListEntriesApi {
|
|
3362
|
+
private readonly t;
|
|
3363
|
+
/** @internal */
|
|
3364
|
+
constructor(t: {
|
|
3365
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
3366
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
3367
|
+
});
|
|
3368
|
+
/**
|
|
3369
|
+
* `POST /screening-lists/:id/entries`: adds or updates 1 to 1000 entries.
|
|
3370
|
+
* An entry with a `reference` the list holds replaces it; one without is
|
|
3371
|
+
* always added. Each entry is checked on its own: a refused one is in
|
|
3372
|
+
* `errors` by its position and the others are written. The API requires an
|
|
3373
|
+
* idempotency key: one is generated when you pass none.
|
|
3374
|
+
*/
|
|
3375
|
+
upsert(listId: string, entries: ClientScreeningListEntryInput[], opts?: RequestOptions): Promise<ClientScreeningListEntriesWrite>;
|
|
3376
|
+
/** The first page of the entries of a list, oldest first. Every page: {@link ScreeningListEntriesApi.iterate}. */
|
|
3377
|
+
list(listId: string, query?: ListScreeningListEntriesQuery): Promise<ClientScreeningListEntry[]>;
|
|
3378
|
+
/** One page of {@link ScreeningListEntriesApi.list} with its `nextCursor` (absent on the last page). */
|
|
3379
|
+
listPage(listId: string, query?: ListScreeningListEntriesQuery): Promise<Page<ClientScreeningListEntry>>;
|
|
3380
|
+
/** Every entry of a list, oldest first, following `nextCursor` page after page. */
|
|
3381
|
+
iterate(listId: string, query?: ListScreeningListEntriesQuery): AsyncGenerator<ClientScreeningListEntry, void, undefined>;
|
|
3382
|
+
/** `GET /screening-lists/:id/entries/:entryId`: `404 screening_list_entry_not_found` when the list has no such entry. */
|
|
3383
|
+
get(listId: string, entryId: string): Promise<ClientScreeningListEntry>;
|
|
3384
|
+
/** `DELETE /screening-lists/:id/entries/:entryId`: removes one entry. */
|
|
3385
|
+
delete(listId: string, entryId: string): Promise<DeletedScreeningListItem>;
|
|
3386
|
+
/** `DELETE /screening-lists/:id/entries?reference=`: removes the entry with your `reference`. */
|
|
3387
|
+
deleteByReference(listId: string, reference: string): Promise<DeletedScreeningListItem>;
|
|
3388
|
+
}
|
|
3389
|
+
/**
|
|
3390
|
+
* Your organization's own screening lists in the key's environment: every AML
|
|
3391
|
+
* screening step searches every active list next to the public lists, unless
|
|
3392
|
+
* its flow leaves the list out. Exposed as {@link Sekyro.screeningLists}.
|
|
3393
|
+
* Reading needs the `screening_lists:read` scope, writing
|
|
3394
|
+
* `screening_lists:write`. Exported as a TYPE only.
|
|
3395
|
+
* @public
|
|
3396
|
+
*/
|
|
3397
|
+
declare class ScreeningListsApi {
|
|
3398
|
+
private readonly t;
|
|
3399
|
+
/** The entries of a list. */
|
|
3400
|
+
readonly entries: ScreeningListEntriesApi;
|
|
3401
|
+
/** @internal */
|
|
3402
|
+
constructor(t: {
|
|
3403
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
3404
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
3405
|
+
});
|
|
3406
|
+
/**
|
|
3407
|
+
* `POST /screening-lists`: creates a list. `409 screening_list_name_taken`
|
|
3408
|
+
* when the environment has a list of that name; `400 screening_list_limit`
|
|
3409
|
+
* past the organization's limit. The API requires an idempotency key: one
|
|
3410
|
+
* is generated when you pass none.
|
|
3411
|
+
*/
|
|
3412
|
+
create(input: CreateScreeningListInput, opts?: RequestOptions): Promise<ClientScreeningList>;
|
|
3413
|
+
/** `GET /screening-lists`: the lists of this environment, by name. */
|
|
3414
|
+
list(): Promise<ClientScreeningList[]>;
|
|
3415
|
+
/** `GET /screening-lists/:id`: `404 screening_list_not_found` for a list of another environment. */
|
|
3416
|
+
get(id: string): Promise<ClientScreeningList>;
|
|
3417
|
+
/**
|
|
3418
|
+
* `PATCH /screening-lists/:id`: renames a list or changes its description,
|
|
3419
|
+
* strictness or `active`; an empty `input` throws a `TypeError`. The API
|
|
3420
|
+
* requires an idempotency key: one is generated when you pass none.
|
|
3421
|
+
*/
|
|
3422
|
+
update(id: string, input: UpdateScreeningListInput, opts?: RequestOptions): Promise<ClientScreeningList>;
|
|
3423
|
+
/** `DELETE /screening-lists/:id`: deletes the list and all its entries. */
|
|
3424
|
+
delete(id: string): Promise<DeletedScreeningListItem>;
|
|
3425
|
+
}
|
|
3213
3426
|
/**
|
|
3214
3427
|
* What you know about a device before you block it. Exposed as {@link Sekyro.devices}. Needs the
|
|
3215
3428
|
* `blocks:read` or `blocks:write` scope. Exported as a TYPE only.
|
|
@@ -3304,6 +3517,7 @@ declare class Sekyro {
|
|
|
3304
3517
|
readonly people: PeopleApi;
|
|
3305
3518
|
readonly blocks: BlocksApi;
|
|
3306
3519
|
readonly signals: SignalsApi;
|
|
3520
|
+
readonly screeningLists: ScreeningListsApi;
|
|
3307
3521
|
readonly devices: DevicesApi;
|
|
3308
3522
|
readonly flows: FlowsApi;
|
|
3309
3523
|
readonly webhooks: WebhooksApi;
|
|
@@ -3326,4 +3540,4 @@ declare class Sekyro {
|
|
|
3326
3540
|
readiness(): Promise<ReadinessReport>;
|
|
3327
3541
|
}
|
|
3328
3542
|
|
|
3329
|
-
export { type
|
|
3543
|
+
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 PoaRuleKind 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 ListScreeningsQuery as aA, type ListSessionsQuery as aB, type ListSignalsQuery as aC, type MatchReason as aD, type MediaBytes as aE, type MediaBytesOptions as aF, type MediaItem as aG, type MediaKind as aH, type MediaList as aI, type NameForm as aJ, type OverridableServiceId as aK, type Page as aL, PeopleApi as aM, type Person as aN, type PersonAddressInput as aO, type PersonBirthPlaceInput as aP, type PersonDeletedEventData as aQ, type PersonDocumentInput as aR, type PersonEnrolledEventData as aS, type PersonRef as aT, type PersonSession as aU, type PersonSessionInput as aV, type PersonSessionTarget as aW, type PersonUpdatedEventData as aX, type PoaDocumentKind as aY, type PoaReason as aZ, type PoaRule 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 ListScreeningListEntriesQuery as az, type ServiceId as b, type SignalSeverity as b$, type PoaRules as b0, type PortraitReportEntry as b1, type PriorReviewReason as b2, type ProbeBindingReason as b3, type ProbeQuality as b4, type ProfileDocumentType as b5, type ReadinessProtection as b6, type ReadinessReport as b7, type RequestOptions as b8, type ResultTokenResponse as b9, type SessionHandoffDevice as bA, type SessionLifecycleEventData as bB, type SessionLinkDelivery as bC, type SessionLinkExpiry as bD, type SessionLinkInput as bE, type SessionNetwork as bF, type SessionNetworkEvent as bG, type SessionNotVerifiedEventData as bH, type SessionRetakeRequestedEventData as bI, type SessionReviewPendingEventData as bJ, type SessionScreening as bK, type SessionStatus as bL, type SessionStep as bM, type SessionStepAttempts as bN, type SessionStepBand as bO, type SessionStepDecision as bP, type SessionStepDocument as bQ, type SessionStepPortrait as bR, SessionTestApi as bS, type SessionVerifiedEventData as bT, SessionsApi as bU, type Signal as bV, type SignalEventData as bW, type SignalEvidence as bX, type SignalGrade as bY, type SignalKeyKind as bZ, type SignalKind as b_, type ReviewOutcomeReason as ba, type RevokePersonInput as bb, type SandboxSimulatedReason as bc, type SandboxSimulation as bd, type ScreenPersonInput as be, type Screening as bf, type ScreeningHit as bg, type ScreeningHitSummary as bh, type ScreeningList as bi, ScreeningListEntriesApi as bj, type ScreeningListStrictness as bk, ScreeningListsApi as bl, type ScreeningStatus as bm, type ScreeningTrigger as bn, type ScreeningUnavailableReason as bo, type SekyroOptions as bp, SekyroTestApi as bq, type Session as br, type SessionClosedEventDataBase as bs, type SessionDecidingStep as bt, type SessionDevice as bu, type SessionEventDataBase as bv, type SessionEventStep as bw, type SessionFailureReason as bx, type SessionFlowRef as by, type SessionHandoff as bz, type SessionPersonInput as c, type SignalStatus as c0, SignalsApi as c1, type SimulateSessionInput as c2, type StepResult as c3, type SubjectAssurance as c4, type SubjectIdNumber as c5, type SubjectName as c6, type SubjectReferenceSource as c7, type SubjectReuseTarget as c8, type SubjectStatus as c9, type UpdateScreeningListInput as ca, type UpdateSignalInput as cb, type UsageLimitReachedEventData as cc, type UsageThresholdReachedEventData as cd, type VerifiedContacts as ce, type WebhookEnvelopeOf as cf, type WebhookEventDataMap as cg, type WebhookTestInput as ch, type WebhookTestResult as ci, WebhooksApi as cj, 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 };
|