@sekyro/node 0.1.0-rc.12 → 0.1.0-rc.14
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 +21 -0
- package/README.md +28 -23
- package/dist/{chunk-SZQEL3LK.js → chunk-IM3UCVDB.js} +1 -1
- package/dist/chunk-J6U2QY7M.js +1 -0
- package/dist/{client-edr9f2Ec.d.cts → client-Dpgpk9cE.d.cts} +374 -15
- package/dist/{client-edr9f2Ec.d.ts → client-Dpgpk9cE.d.ts} +374 -15
- package/dist/connect/express/index.cjs +1 -1
- 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.cjs +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-C0M4NWwZ.d.cts → connector-B9XkmMMb.d.ts} +39 -6
- package/dist/{connector-DKP_ebGH.d.ts → connector-DL-RL9jQ.d.cts} +39 -6
- 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/dist/chunk-D53NUEJ6.js +0 -1
|
@@ -120,7 +120,7 @@ interface SessionLinkInput {
|
|
|
120
120
|
*/
|
|
121
121
|
type IdentityMethod = "national_number" | "document_photo" | "document_chip" | "national_eid";
|
|
122
122
|
/** The verification checks a flow may contain. @public */
|
|
123
|
-
type CheckType = "liveness" | "face_match" | "doc_ocr" | "population_registry" | "phone_otp" | "nfc_chip" | "email_otp" | "portrait_icao" | "eid_auth";
|
|
123
|
+
type CheckType = "liveness" | "face_match" | "doc_ocr" | "population_registry" | "phone_otp" | "nfc_chip" | "email_otp" | "portrait_icao" | "eid_auth" | "aml_screening";
|
|
124
124
|
/** Per-check execution state within a session. @public */
|
|
125
125
|
type CheckState = "pending" | "input_required" | "processing" | "passed" | "failed" | "review" | "skipped";
|
|
126
126
|
/**
|
|
@@ -138,10 +138,12 @@ type CheckState = "pending" | "input_required" | "processing" | "passed" | "fail
|
|
|
138
138
|
* - `platform_unsupported` — the flow requires a chip read and the person
|
|
139
139
|
* opened the link on the web (the link stays usable in a native app);
|
|
140
140
|
* - `cancelled_by_organization` — you cancelled the session
|
|
141
|
-
* ({@link SessionsApi.cancel})
|
|
141
|
+
* ({@link SessionsApi.cancel});
|
|
142
|
+
* - `blocked_by_org`: one of your blocks (a device, a person, an account or a
|
|
143
|
+
* contact) stopped the session. Not retryable, not billed.
|
|
142
144
|
* @public
|
|
143
145
|
*/
|
|
144
|
-
type SessionFailureReason = "location_not_allowed" | "anonymizer_blocked" | "capture_tampered" | "device_velocity_exceeded" | "device_cooldown" | "platform_unsupported" | "cancelled_by_organization";
|
|
146
|
+
type SessionFailureReason = "location_not_allowed" | "anonymizer_blocked" | "capture_tampered" | "device_velocity_exceeded" | "device_cooldown" | "platform_unsupported" | "cancelled_by_organization" | "blocked_by_org";
|
|
145
147
|
/**
|
|
146
148
|
* Profile-v2 decision-mode reasons a check's {@link SessionStep.reason} may
|
|
147
149
|
* carry when the app decides automatically (`decisions.mode: 'automatic'`)
|
|
@@ -177,7 +179,7 @@ type EligibilityReason = "document_type_not_accepted" | "nationality_not_allowed
|
|
|
177
179
|
* nobody settled it); those two carry `decidedBy: "automatic"`.
|
|
178
180
|
* @public
|
|
179
181
|
*/
|
|
180
|
-
type PolicyFailureReason = SessionFailureReason | EligibilityReason | "document_id_number_mismatch" | "document_nni_mismatch" | "camera_unavailable" | "subject_face_mismatch" | "review_timeout" | "review_split";
|
|
182
|
+
type PolicyFailureReason = SessionFailureReason | EligibilityReason | "document_id_number_mismatch" | "document_nni_mismatch" | "camera_unavailable" | "subject_face_mismatch" | "review_timeout" | "review_split" | "aml_hit";
|
|
181
183
|
/**
|
|
182
184
|
* The ID-number reasons a check's {@link SessionStep.reason} may carry (person data
|
|
183
185
|
* spec Appendix A.2), each under its generic name and its former Mauritanian name:
|
|
@@ -232,7 +234,7 @@ type ReviewOutcomeReason = "superseded_by_retry" | "review_split";
|
|
|
232
234
|
* reviewer overrode on an approval.
|
|
233
235
|
* @public
|
|
234
236
|
*/
|
|
235
|
-
type ReviewReason = "document_authenticity" | "liveness" | "face_match" | "data_mismatch" | "other";
|
|
237
|
+
type ReviewReason = "document_authenticity" | "liveness" | "face_match" | "data_mismatch" | "screening" | "org_rule" | "other";
|
|
236
238
|
/**
|
|
237
239
|
* How a person decided a step: a reviewer (`source: "review"`), or an earlier
|
|
238
240
|
* review of the same person, reference photo and face that was reused
|
|
@@ -300,9 +302,8 @@ interface FailureIdentification {
|
|
|
300
302
|
*/
|
|
301
303
|
type ProbeBindingReason = "probe_not_from_liveness";
|
|
302
304
|
/**
|
|
303
|
-
* The languages the person being verified sees (hosted flow and SDK screens; spec 2026-10-29 §9)
|
|
304
|
-
*
|
|
305
|
-
* email messages stay in `ar`, `fr` or `en` (English for the three others).
|
|
305
|
+
* The languages the person being verified sees (hosted flow and SDK screens; spec 2026-10-29 §9), every screen in
|
|
306
|
+
* each. SMS and email messages stay in `ar`, `fr` or `en` (English for the three others).
|
|
306
307
|
* @public
|
|
307
308
|
*/
|
|
308
309
|
type Locale = "ar" | "fr" | "en" | "es" | "pt" | "de";
|
|
@@ -773,9 +774,14 @@ interface FlowServiceSettings {
|
|
|
773
774
|
reference: "auto" | "document" | "registry";
|
|
774
775
|
attempts?: number;
|
|
775
776
|
};
|
|
777
|
+
/**
|
|
778
|
+
* Sanctions and PEP screening of the person the flow verified. `onHit`: `signal`
|
|
779
|
+
* (the session goes on and the match is reported), `review` (a reviewer
|
|
780
|
+
* decides) or `fail` (the session is rejected with `aml_hit`).
|
|
781
|
+
*/
|
|
776
782
|
aml_screening: {
|
|
777
|
-
lists:
|
|
778
|
-
onHit: "review" | "fail";
|
|
783
|
+
lists: ScreeningList[];
|
|
784
|
+
onHit: "signal" | "review" | "fail";
|
|
779
785
|
};
|
|
780
786
|
face_dedup: {
|
|
781
787
|
scope: "app" | "org";
|
|
@@ -1136,7 +1142,13 @@ interface SessionDevice {
|
|
|
1136
1142
|
browserVersion?: string;
|
|
1137
1143
|
deviceClass: "mobile" | "tablet" | "desktop" | "unknown";
|
|
1138
1144
|
model?: string;
|
|
1139
|
-
/**
|
|
1145
|
+
/**
|
|
1146
|
+
* Opaque device identity inside your organization and environment, stable across sessions
|
|
1147
|
+
* while the device keeps its install id. May be absent (for example without a device
|
|
1148
|
+
* header).
|
|
1149
|
+
*/
|
|
1150
|
+
deviceId?: string;
|
|
1151
|
+
/** Hashed device keys of this session, per organization. */
|
|
1140
1152
|
deviceKeys: string[];
|
|
1141
1153
|
signals: SessionDeviceSignal[];
|
|
1142
1154
|
}
|
|
@@ -1435,7 +1447,8 @@ interface Session {
|
|
|
1435
1447
|
/**
|
|
1436
1448
|
* Risk signals recorded on the session (e.g. `device_velocity`,
|
|
1437
1449
|
* `timezone_mismatch`, `icao_non_compliant` when an `alert` ICAO policy flagged
|
|
1438
|
-
* the selfie
|
|
1450
|
+
* the selfie, `document_uploaded` and the `document_upload_*` signals when the
|
|
1451
|
+
* person uploaded a photo of the document) — signals only, never a verdict by themselves.
|
|
1439
1452
|
*/
|
|
1440
1453
|
riskSignals?: string[];
|
|
1441
1454
|
/**
|
|
@@ -1491,6 +1504,11 @@ interface Session {
|
|
|
1491
1504
|
* setting is on. A signal, never a decision.
|
|
1492
1505
|
*/
|
|
1493
1506
|
failureIdentification?: FailureIdentification;
|
|
1507
|
+
/**
|
|
1508
|
+
* Terminal sessions whose flow screens the person against sanctions and PEP
|
|
1509
|
+
* lists: the result ({@link SessionScreening}), or why it could not run.
|
|
1510
|
+
*/
|
|
1511
|
+
screening?: SessionScreening;
|
|
1494
1512
|
}
|
|
1495
1513
|
/**
|
|
1496
1514
|
* `data` of the session lifecycle events (`session.started` |
|
|
@@ -1618,6 +1636,8 @@ interface SessionLifecycleEventData {
|
|
|
1618
1636
|
* found one before the event was sent. A signal, never a decision.
|
|
1619
1637
|
*/
|
|
1620
1638
|
failureIdentification?: FailureIdentification;
|
|
1639
|
+
/** On `completed` / `failed`: the AML screening result ({@link SessionScreening}), when the flow screens the person. */
|
|
1640
|
+
screening?: SessionScreening;
|
|
1621
1641
|
}
|
|
1622
1642
|
/**
|
|
1623
1643
|
* `data` of `subject.updated` — either a session linked to the subject reached
|
|
@@ -1775,11 +1795,145 @@ interface ListSessionsQuery {
|
|
|
1775
1795
|
createdAfter?: string | Date;
|
|
1776
1796
|
/** Sessions created before this time (ISO 8601 or a `Date`). */
|
|
1777
1797
|
createdBefore?: string | Date;
|
|
1798
|
+
/** Only the sessions of this device (`device.deviceId` of a session). */
|
|
1799
|
+
deviceId?: string;
|
|
1800
|
+
/** Page size, 1 to 100 (the API's default is 50). */
|
|
1801
|
+
limit?: number;
|
|
1802
|
+
/** The {@link Page.nextCursor} of the previous page. */
|
|
1803
|
+
cursor?: string;
|
|
1804
|
+
}
|
|
1805
|
+
/**
|
|
1806
|
+
* What a block holds, as {@link BlocksApi.list} shows it. `face` blocks are made in the dashboard.
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
type BlockKind = "id_number" | "external_ref" | "phone" | "email" | "device" | "face";
|
|
1810
|
+
/** Why a block exists. `rule`: an automatic rule made it. @public */
|
|
1811
|
+
type BlockReason = "fraud_confirmed" | "chargeback" | "abuse" | "test" | "rule" | "other";
|
|
1812
|
+
/** How long a block lasts; `null` has no end. @public */
|
|
1813
|
+
type BlockDuration = "P1D" | "P7D" | "P30D" | null;
|
|
1814
|
+
/**
|
|
1815
|
+
* A block on one key of this environment. Never a value or a hash.
|
|
1816
|
+
* @public
|
|
1817
|
+
*/
|
|
1818
|
+
interface Block {
|
|
1819
|
+
/** `blk_...` */
|
|
1820
|
+
id: string;
|
|
1821
|
+
kind: BlockKind;
|
|
1822
|
+
/** Four characters derived from the key, to tell blocks apart. */
|
|
1823
|
+
label: string;
|
|
1824
|
+
/** The device, on a device block. */
|
|
1825
|
+
deviceId?: string;
|
|
1826
|
+
effect: "block" | "flag" | "review";
|
|
1827
|
+
reason: BlockReason;
|
|
1828
|
+
/** When it ends; `null` has no end. */
|
|
1829
|
+
expiresAt: string | null;
|
|
1830
|
+
createdAt: string;
|
|
1831
|
+
status: "active" | "lifted" | "expired";
|
|
1832
|
+
/** `rul_...`: the rule that made it, on a block made by a rule. Such a block has no end date. */
|
|
1833
|
+
ruleId?: string;
|
|
1834
|
+
/** The version of that rule when it made the block. */
|
|
1835
|
+
ruleVersion?: number;
|
|
1836
|
+
liftedAt?: string;
|
|
1837
|
+
}
|
|
1838
|
+
/** An ID number as a document shows it. Hashed by the API, never stored. @public */
|
|
1839
|
+
interface BlockIdNumber {
|
|
1840
|
+
number: string;
|
|
1841
|
+
/** ISO 3166-1 alpha-2 or alpha-3 code of the issuer. */
|
|
1842
|
+
issuingCountry: string;
|
|
1843
|
+
type: "national_id" | "passport" | "residence_permit";
|
|
1844
|
+
}
|
|
1845
|
+
/**
|
|
1846
|
+
* What to block, with `sekyro.blocks.create`. `value` carries `external_ref`, `phone` and
|
|
1847
|
+
* `email`; `person` blocks each ID number of the person and answers a list.
|
|
1848
|
+
* @public
|
|
1849
|
+
*/
|
|
1850
|
+
type CreateBlockInput = {
|
|
1851
|
+
expiresIn: BlockDuration;
|
|
1852
|
+
reason?: Exclude<BlockReason, "rule">;
|
|
1853
|
+
/** Your note. It stays on your dashboard. */
|
|
1854
|
+
note?: string;
|
|
1855
|
+
} & ({
|
|
1856
|
+
kind: "external_ref" | "phone" | "email";
|
|
1857
|
+
value: string;
|
|
1858
|
+
} | {
|
|
1859
|
+
kind: "id_number";
|
|
1860
|
+
idNumber: BlockIdNumber;
|
|
1861
|
+
} | {
|
|
1862
|
+
kind: "person";
|
|
1863
|
+
personId: string;
|
|
1864
|
+
} | ({
|
|
1865
|
+
kind: "device";
|
|
1866
|
+
force?: boolean;
|
|
1867
|
+
} & ({
|
|
1868
|
+
deviceId: string;
|
|
1869
|
+
} | {
|
|
1870
|
+
sessionId: string;
|
|
1871
|
+
})));
|
|
1872
|
+
/** What to look up, with {@link BlocksApi.check}. @public */
|
|
1873
|
+
type BlockCheckInput = {
|
|
1874
|
+
kind: "external_ref" | "phone" | "email";
|
|
1875
|
+
value: string;
|
|
1876
|
+
} | {
|
|
1877
|
+
kind: "id_number";
|
|
1878
|
+
idNumber: BlockIdNumber;
|
|
1879
|
+
} | {
|
|
1880
|
+
kind: "person";
|
|
1881
|
+
personId: string;
|
|
1882
|
+
} | {
|
|
1883
|
+
kind: "device";
|
|
1884
|
+
deviceId: string;
|
|
1885
|
+
};
|
|
1886
|
+
/** The answer of {@link BlocksApi.check}. @public */
|
|
1887
|
+
interface BlockCheck {
|
|
1888
|
+
blocked: boolean;
|
|
1889
|
+
/** When the block ends; `null` has no end. Only when blocked. */
|
|
1890
|
+
expiresAt?: string | null;
|
|
1891
|
+
}
|
|
1892
|
+
/** Why a block is lifted, with {@link BlocksApi.lift}. @public */
|
|
1893
|
+
interface LiftBlockInput {
|
|
1894
|
+
/**
|
|
1895
|
+
* `false_positive` also marks the signal behind the block, so no rule fires on it again. On a
|
|
1896
|
+
* block made by a rule it counts against the rule, which pauses after too many reports.
|
|
1897
|
+
*/
|
|
1898
|
+
reason?: "false_positive" | "other";
|
|
1899
|
+
note?: string;
|
|
1900
|
+
}
|
|
1901
|
+
/**
|
|
1902
|
+
* Filters of {@link BlocksApi.list}, {@link BlocksApi.listPage} and {@link BlocksApi.iterate}.
|
|
1903
|
+
* Newest first.
|
|
1904
|
+
* @public
|
|
1905
|
+
*/
|
|
1906
|
+
interface ListBlocksQuery {
|
|
1907
|
+
kind?: BlockKind;
|
|
1908
|
+
status?: Block["status"];
|
|
1778
1909
|
/** Page size, 1 to 100 (the API's default is 50). */
|
|
1779
1910
|
limit?: number;
|
|
1780
1911
|
/** The {@link Page.nextCursor} of the previous page. */
|
|
1781
1912
|
cursor?: string;
|
|
1782
1913
|
}
|
|
1914
|
+
/**
|
|
1915
|
+
* A device of this environment, counted inside it.
|
|
1916
|
+
* @public
|
|
1917
|
+
*/
|
|
1918
|
+
interface Device {
|
|
1919
|
+
/** `dev_...`, as a session's `device.deviceId`. */
|
|
1920
|
+
deviceId: string;
|
|
1921
|
+
platform: "web" | "android" | "ios";
|
|
1922
|
+
model?: string;
|
|
1923
|
+
firstSeenAt: string;
|
|
1924
|
+
lastSeenAt: string;
|
|
1925
|
+
/** Your sessions on this device. */
|
|
1926
|
+
sessions: number;
|
|
1927
|
+
/** Distinct verified people among them over 90 days. */
|
|
1928
|
+
people: number;
|
|
1929
|
+
/** An agent filmed on it, many verified people passed on it, or you marked it. */
|
|
1930
|
+
shared: boolean;
|
|
1931
|
+
/** Its active block. */
|
|
1932
|
+
block: {
|
|
1933
|
+
id: string;
|
|
1934
|
+
expiresAt: string | null;
|
|
1935
|
+
} | null;
|
|
1936
|
+
}
|
|
1783
1937
|
/**
|
|
1784
1938
|
* Filters of {@link PeopleApi.list}, {@link PeopleApi.listPage} and
|
|
1785
1939
|
* {@link PeopleApi.iterate}. Newest first; only people who passed a verification.
|
|
@@ -1810,6 +1964,130 @@ interface DeletedPerson {
|
|
|
1810
1964
|
}
|
|
1811
1965
|
/** @deprecated Use {@link DeletedPerson}. @public */
|
|
1812
1966
|
type DeletedSubject = DeletedPerson;
|
|
1967
|
+
/** The lists an AML screening can search. @public */
|
|
1968
|
+
type ScreeningList = "sanctions" | "pep" | "adverse_media";
|
|
1969
|
+
/**
|
|
1970
|
+
* Where a screening stands: `clear` (nothing scored above the possible
|
|
1971
|
+
* threshold), `possible` (a possible match), `hit` (a match), `confirmed` or
|
|
1972
|
+
* `dismissed` (a person of your organization decided the hits), `unavailable`
|
|
1973
|
+
* (the lists could not be searched; never billed).
|
|
1974
|
+
* @public
|
|
1975
|
+
*/
|
|
1976
|
+
type ScreeningStatus = "clear" | "possible" | "hit" | "confirmed" | "dismissed" | "unavailable";
|
|
1977
|
+
/** Why the lists could not be searched. @public */
|
|
1978
|
+
type ScreeningUnavailableReason = "screening_unavailable" | "no_identity_data" | "no_list_covered";
|
|
1979
|
+
/** What ran a screening: a session step, a screening run again, or ongoing screening. @public */
|
|
1980
|
+
type ScreeningTrigger = "session" | "rescreen" | "monitor";
|
|
1981
|
+
/** A list entry that matched the person, best first. Public list data. @public */
|
|
1982
|
+
interface ScreeningHitSummary {
|
|
1983
|
+
/** The stable id of the list entry. */
|
|
1984
|
+
entityId: string;
|
|
1985
|
+
/** The name of the entry as the list publishes it. */
|
|
1986
|
+
caption: string;
|
|
1987
|
+
/** How closely the entry matches the person, 0 to 1. */
|
|
1988
|
+
score: number;
|
|
1989
|
+
/** The searched lists the entry is on. */
|
|
1990
|
+
lists: ScreeningList[];
|
|
1991
|
+
}
|
|
1992
|
+
/** A list entry that matched, with its public attributes and sources. @public */
|
|
1993
|
+
interface ScreeningHit extends ScreeningHitSummary {
|
|
1994
|
+
/** The tags of the entry on its lists (`sanction`, `role.pep`, ...). */
|
|
1995
|
+
topics: string[];
|
|
1996
|
+
/** The source datasets of the entry. */
|
|
1997
|
+
datasets: string[];
|
|
1998
|
+
/** Public attributes of the entry, when the list publishes them. */
|
|
1999
|
+
attributes: {
|
|
2000
|
+
birthDates?: string[];
|
|
2001
|
+
nationalities?: string[];
|
|
2002
|
+
positions?: string[];
|
|
2003
|
+
aliases?: string[];
|
|
2004
|
+
gender?: string;
|
|
2005
|
+
};
|
|
2006
|
+
/** Where the list publishes the entry. */
|
|
2007
|
+
sourceUrls: string[];
|
|
2008
|
+
firstSeen?: string;
|
|
2009
|
+
lastSeen?: string;
|
|
2010
|
+
}
|
|
2011
|
+
/**
|
|
2012
|
+
* {@link Session.screening}: the search a session's AML screening step ran, or
|
|
2013
|
+
* `{ unavailable }` alone when it could not run.
|
|
2014
|
+
* @public
|
|
2015
|
+
*/
|
|
2016
|
+
type SessionScreening = {
|
|
2017
|
+
/** The screening id (`scr_...`); see {@link PeopleApi.screenings}. */
|
|
2018
|
+
id: string;
|
|
2019
|
+
status: Exclude<ScreeningStatus, "unavailable">;
|
|
2020
|
+
/** The lists the flow asked for. */
|
|
2021
|
+
lists: ScreeningList[];
|
|
2022
|
+
/** The lists actually searched. */
|
|
2023
|
+
listsCovered: ScreeningList[];
|
|
2024
|
+
/** The list data release the search ran on. */
|
|
2025
|
+
datasetVersion: string;
|
|
2026
|
+
/** The best score, 0 when nothing matched. */
|
|
2027
|
+
topScore: number;
|
|
2028
|
+
hits: ScreeningHitSummary[];
|
|
2029
|
+
} | {
|
|
2030
|
+
unavailable: ScreeningUnavailableReason;
|
|
2031
|
+
};
|
|
2032
|
+
/** One screening of a person ({@link PeopleApi.screen}, {@link PeopleApi.screenings}). @public */
|
|
2033
|
+
interface Screening {
|
|
2034
|
+
/** The screening id (`scr_...`). */
|
|
2035
|
+
id: string;
|
|
2036
|
+
trigger: ScreeningTrigger;
|
|
2037
|
+
status: ScreeningStatus;
|
|
2038
|
+
/** With `status: "unavailable"`: why the lists could not be searched. */
|
|
2039
|
+
unavailable?: ScreeningUnavailableReason;
|
|
2040
|
+
/** The lists asked for. */
|
|
2041
|
+
lists: ScreeningList[];
|
|
2042
|
+
/** The lists actually searched. */
|
|
2043
|
+
listsCovered: ScreeningList[];
|
|
2044
|
+
/** The list data release the search ran on. */
|
|
2045
|
+
datasetVersion: string;
|
|
2046
|
+
/** The best score, 0 when nothing matched. */
|
|
2047
|
+
topScore: number;
|
|
2048
|
+
/** The matching entries, best first. */
|
|
2049
|
+
hits: ScreeningHit[];
|
|
2050
|
+
/** The decision of a person of your organization on the hits, once made. */
|
|
2051
|
+
decision?: {
|
|
2052
|
+
outcome: "confirmed" | "dismissed";
|
|
2053
|
+
at: string;
|
|
2054
|
+
note?: string;
|
|
2055
|
+
};
|
|
2056
|
+
/** ISO 8601. */
|
|
2057
|
+
createdAt: string;
|
|
2058
|
+
}
|
|
2059
|
+
/** Input of {@link PeopleApi.screen}. @public */
|
|
2060
|
+
interface ScreenPersonInput {
|
|
2061
|
+
/** The lists to search, each once. Default `["sanctions", "pep"]`. */
|
|
2062
|
+
lists?: ScreeningList[];
|
|
2063
|
+
}
|
|
2064
|
+
/** Query of {@link PeopleApi.screenings}. @public */
|
|
2065
|
+
interface ListScreeningsQuery {
|
|
2066
|
+
/** Page size, 1 to 50 (the API's default is 25). */
|
|
2067
|
+
limit?: number;
|
|
2068
|
+
/** The {@link Page.nextCursor} of the previous page. */
|
|
2069
|
+
cursor?: string;
|
|
2070
|
+
}
|
|
2071
|
+
/**
|
|
2072
|
+
* `data` of `aml.match_flagged`: a screening settled `hit` or `possible`, from
|
|
2073
|
+
* a session step, a screening run again or ongoing screening. Sent once per
|
|
2074
|
+
* screening (de-duplicate on `screeningId`); a decision sends no event.
|
|
2075
|
+
* @public
|
|
2076
|
+
*/
|
|
2077
|
+
interface AmlMatchFlaggedEventData {
|
|
2078
|
+
screeningId: string;
|
|
2079
|
+
trigger: ScreeningTrigger;
|
|
2080
|
+
/** The session the screening ran in, or the person's latest approved session. */
|
|
2081
|
+
sessionId?: string;
|
|
2082
|
+
/** The person (`per_...`), once known. */
|
|
2083
|
+
personId?: string;
|
|
2084
|
+
status: "hit" | "possible";
|
|
2085
|
+
lists: ScreeningList[];
|
|
2086
|
+
listsCovered: ScreeningList[];
|
|
2087
|
+
datasetVersion: string;
|
|
2088
|
+
topScore: number;
|
|
2089
|
+
hits: ScreeningHitSummary[];
|
|
2090
|
+
}
|
|
1813
2091
|
/** Options of {@link PeopleApi.revoke}. @public */
|
|
1814
2092
|
interface RevokePersonInput {
|
|
1815
2093
|
/** Kept on the audit trail only (≤ 500 characters). Do not put personal data here. */
|
|
@@ -2057,8 +2335,7 @@ interface WebhookEventDataMap {
|
|
|
2057
2335
|
"subject.suspicious_activity": SubjectSuspiciousActivityEventData;
|
|
2058
2336
|
/** @deprecated Subscribe to `person.deleted`, sent next to it with `personId`. */
|
|
2059
2337
|
"subject.deleted": SubjectDeletedEventData;
|
|
2060
|
-
|
|
2061
|
-
"aml.match_flagged": Record<string, unknown>;
|
|
2338
|
+
"aml.match_flagged": AmlMatchFlaggedEventData;
|
|
2062
2339
|
"payment.received": Record<string, unknown>;
|
|
2063
2340
|
"invoice.generated": Record<string, unknown>;
|
|
2064
2341
|
"invoice.paid": Record<string, unknown>;
|
|
@@ -2145,6 +2422,7 @@ interface ConnectorIdentity {
|
|
|
2145
2422
|
/** The connector package version, for example `0.1.0`: at most 64 characters. */
|
|
2146
2423
|
version: string;
|
|
2147
2424
|
}
|
|
2425
|
+
type HttpMethod = "GET" | "POST" | "PATCH" | "DELETE";
|
|
2148
2426
|
/**
|
|
2149
2427
|
* `sekyro.sessions` — create and read verification sessions.
|
|
2150
2428
|
*
|
|
@@ -2307,6 +2585,27 @@ declare class PeopleApi {
|
|
|
2307
2585
|
* Emits `person.updated` (and `subject.updated`) with `status: 'revoked'`.
|
|
2308
2586
|
*/
|
|
2309
2587
|
revoke(id: string, input?: RevokePersonInput, opts?: RequestOptions): Promise<Person>;
|
|
2588
|
+
/**
|
|
2589
|
+
* `POST /people/:id/screen` — screens a verified person again against
|
|
2590
|
+
* sanctions and PEP lists (`lists`, default sanctions and PEP), from the
|
|
2591
|
+
* person's stored name, birth date and the issuing countries of their identity
|
|
2592
|
+
* numbers. Billed as one AML screening; a refusal is not billed
|
|
2593
|
+
* (`400 screening_list_not_covered`, `403 service_not_in_plan`,
|
|
2594
|
+
* `503 screening_unavailable`). A hit or a possible match also sends
|
|
2595
|
+
* `aml.match_flagged`. Pass an `idempotencyKey` so a retried call is not
|
|
2596
|
+
* billed twice.
|
|
2597
|
+
*/
|
|
2598
|
+
screen(id: string, input?: ScreenPersonInput, opts?: RequestOptions): Promise<Screening>;
|
|
2599
|
+
/**
|
|
2600
|
+
* The first page of a person's screenings, newest first
|
|
2601
|
+
* (`GET /people/:id/screenings`; 25 by default, at most 50 with `limit`).
|
|
2602
|
+
* Every page: {@link PeopleApi.iterateScreenings}.
|
|
2603
|
+
*/
|
|
2604
|
+
screenings(id: string, query?: ListScreeningsQuery): Promise<Screening[]>;
|
|
2605
|
+
/** One page of {@link PeopleApi.screenings} with its `nextCursor` (absent on the last page). */
|
|
2606
|
+
screeningsPage(id: string, query?: ListScreeningsQuery): Promise<Page<Screening>>;
|
|
2607
|
+
/** Every screening of a person, newest first, following `nextCursor` page after page. */
|
|
2608
|
+
iterateScreenings(id: string, query?: ListScreeningsQuery): AsyncGenerator<Screening, void, undefined>;
|
|
2310
2609
|
/**
|
|
2311
2610
|
* `DELETE /people/:id` — deletes the person's stored photos, face
|
|
2312
2611
|
* templates and identifiers, and the personal data and media of their
|
|
@@ -2331,6 +2630,64 @@ declare class PeopleApi {
|
|
|
2331
2630
|
* @public
|
|
2332
2631
|
*/
|
|
2333
2632
|
type SubjectsApi = PeopleApi;
|
|
2633
|
+
/**
|
|
2634
|
+
* Stops the next sessions of a device, a person, an account or a contact. Exposed as
|
|
2635
|
+
* {@link Sekyro.blocks}. Needs the `blocks:read` or `blocks:write` scope.
|
|
2636
|
+
* Exported as a TYPE only.
|
|
2637
|
+
* @public
|
|
2638
|
+
*/
|
|
2639
|
+
declare class BlocksApi {
|
|
2640
|
+
private readonly t;
|
|
2641
|
+
/** @internal */
|
|
2642
|
+
constructor(t: {
|
|
2643
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
2644
|
+
page<T>(path: string): Promise<Page<T>>;
|
|
2645
|
+
});
|
|
2646
|
+
/**
|
|
2647
|
+
* `POST /blocks`: blocks the key, or answers the active block already on it. `kind: "person"`
|
|
2648
|
+
* blocks each ID number of the person and answers a list. A shared device answers
|
|
2649
|
+
* `409 device_shared` with `details.people` unless `force: true`. `403 blocks_disabled` while blocks
|
|
2650
|
+
* are turned off. The API requires an idempotency key: one is generated when you pass none, so
|
|
2651
|
+
* pass your own to make a retry of the same call safe.
|
|
2652
|
+
*/
|
|
2653
|
+
create(input: CreateBlockInput & {
|
|
2654
|
+
kind: "person";
|
|
2655
|
+
}, opts?: RequestOptions): Promise<Block[]>;
|
|
2656
|
+
create(input: CreateBlockInput, opts?: RequestOptions): Promise<Block>;
|
|
2657
|
+
/** The first page of the blocks of this environment, newest first. Every page: {@link BlocksApi.iterate}. */
|
|
2658
|
+
list(query?: ListBlocksQuery): Promise<Block[]>;
|
|
2659
|
+
/** One page of {@link BlocksApi.list} with its `nextCursor` (absent on the last page). */
|
|
2660
|
+
listPage(query?: ListBlocksQuery): Promise<Page<Block>>;
|
|
2661
|
+
/** Every block matching `query`, newest first, following `nextCursor` page after page. */
|
|
2662
|
+
iterate(query?: ListBlocksQuery): AsyncGenerator<Block, void, undefined>;
|
|
2663
|
+
/** `GET /blocks/:id`. */
|
|
2664
|
+
get(id: string): Promise<Block>;
|
|
2665
|
+
/** `DELETE /blocks/:id`: the next sessions on its key go through. Lifting again is a no-op. */
|
|
2666
|
+
lift(id: string, input?: LiftBlockInput, opts?: RequestOptions): Promise<Block>;
|
|
2667
|
+
/** `POST /blocks/check`: whether a value is blocked. A POST, so it never sits in a URL or a log. */
|
|
2668
|
+
check(input: BlockCheckInput): Promise<BlockCheck>;
|
|
2669
|
+
}
|
|
2670
|
+
/**
|
|
2671
|
+
* What you know about a device before you block it. Exposed as {@link Sekyro.devices}. Needs the
|
|
2672
|
+
* `blocks:read` or `blocks:write` scope. Exported as a TYPE only.
|
|
2673
|
+
* @public
|
|
2674
|
+
*/
|
|
2675
|
+
declare class DevicesApi {
|
|
2676
|
+
private readonly t;
|
|
2677
|
+
/** @internal */
|
|
2678
|
+
constructor(t: {
|
|
2679
|
+
call<T>(method: HttpMethod, path: string, body?: unknown, idempotencyKey?: string): Promise<T>;
|
|
2680
|
+
});
|
|
2681
|
+
/** `GET /devices/:deviceId`: `404 device_not_found` for a device of another environment. */
|
|
2682
|
+
get(deviceId: string): Promise<Device>;
|
|
2683
|
+
/**
|
|
2684
|
+
* `PATCH /devices/:deviceId`: marks or unmarks the device as shared. Unmarking only clears your
|
|
2685
|
+
* own mark: a device recognised as shared from its sessions stays shared.
|
|
2686
|
+
*/
|
|
2687
|
+
update(deviceId: string, input: {
|
|
2688
|
+
shared: boolean;
|
|
2689
|
+
}, opts?: RequestOptions): Promise<Device>;
|
|
2690
|
+
}
|
|
2334
2691
|
/**
|
|
2335
2692
|
* Sekyro AI partner API client. Server-side only: it carries your API key.
|
|
2336
2693
|
*
|
|
@@ -2349,6 +2706,8 @@ declare class Sekyro {
|
|
|
2349
2706
|
#private;
|
|
2350
2707
|
readonly sessions: SessionsApi;
|
|
2351
2708
|
readonly people: PeopleApi;
|
|
2709
|
+
readonly blocks: BlocksApi;
|
|
2710
|
+
readonly devices: DevicesApi;
|
|
2352
2711
|
/** @deprecated Use {@link Sekyro.people}: the same object. */
|
|
2353
2712
|
readonly subjects: PeopleApi;
|
|
2354
2713
|
constructor(opts: SekyroOptions);
|
|
@@ -2361,4 +2720,4 @@ declare class Sekyro {
|
|
|
2361
2720
|
listFlows(): Promise<FlowSummary[]>;
|
|
2362
2721
|
}
|
|
2363
2722
|
|
|
2364
|
-
export { type
|
|
2723
|
+
export { type FlowServiceSettings as $, type AgeMethod as A, type Block as B, type CreatedSession as C, type CreateSessionInput as D, type CreatedSessionWarning as E, type FetchLike as F, DEFAULT_BASE_URL as G, DEFAULT_TIMEOUT_MS as H, type DecidedBy as I, type DecisionReason as J, type DeepPartial as K, type Locale as L, type DeletedPerson as M, type DeletedSubject as N, type DeliverOptions as O, type Device as P, DevicesApi as Q, type ReviewReason as R, Sekyro as S, type DocumentSubstitutionSettings as T, type EidResult as U, type VerificationLevel as V, type WebhookEventType as W, type EligibilityReason as X, type ExtendLinkInput as Y, type FlowOverridableSettings as Z, type FlowOverrides as _, type ServiceId as a, type SessionLinkDelivery as a$, type FlowSummary 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 PolicyFailureReason as aA, type PortraitReportEntry as aB, type PriorReviewReason as aC, type ProbeBindingReason as aD, type ProbeQuality as aE, type ProfileDocumentType as aF, type RequestOptions as aG, type ResultTokenResponse as aH, type ReviewOutcomeReason as aI, type RevokePersonInput as aJ, type RevokeSubjectInput as aK, type ScreenPersonInput as aL, type Screening as aM, type ScreeningHit as aN, type ScreeningHitSummary as aO, type ScreeningList as aP, type ScreeningStatus as aQ, type ScreeningTrigger as aR, type ScreeningUnavailableReason as aS, type SekyroOptions as aT, type Session as aU, type SessionDevice as aV, type SessionDeviceSignal as aW, type SessionEventData as aX, type SessionFailureReason as aY, type SessionFlowRef as aZ, type SessionLifecycleEventData 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 MatchReason as ah, type MediaBytes as ai, type MediaBytesOptions as aj, type MediaItem as ak, type MediaKind as al, type MediaList as am, type NameForm as an, type Page as ao, PeopleApi as ap, type Person as aq, type PersonBirthPlaceInput as ar, type PersonDeletedEventData as as, type PersonDocumentInput as at, type PersonEnrolledEventData as au, type PersonSession as av, type PersonSessionInput as aw, type PersonSessionTarget as ax, type PersonSuspiciousActivityEventData as ay, type PersonUpdatedEventData as az, type SessionPersonInput as b, type SessionLinkExpiry as b0, type SessionLinkInput as b1, type SessionNetwork as b2, type SessionNetworkEvent as b3, type SessionPortraitLink as b4, type SessionReviewDecidedEventData as b5, type SessionScreening as b6, type SessionStatus as b7, type SessionStep as b8, type SessionStepCompletedEventData as b9, type SessionStepDecision as ba, type SessionSubjectInput as bb, type SessionSupersededEventData as bc, SessionsApi as bd, type Subject as be, type SubjectAssurance as bf, type SubjectDeletedEventData as bg, type SubjectEnrolledEventData as bh, type SubjectIdNumber as bi, type SubjectName as bj, type SubjectReferenceSource as bk, type SubjectReuseDocument as bl, type SubjectReuseTarget as bm, type SubjectSession as bn, type SubjectSessionInput as bo, type SubjectSessionTarget as bp, type SubjectStatus as bq, type SubjectSuspiciousActivityEventData as br, type SubjectUpdatedEventData as bs, type SubjectsApi as bt, type SuppliedIdentityRecord as bu, type UsageThresholdReachedEventData as bv, type VerifiedContacts as bw, type WebhookEnvelopeOf as bx, type WebhookEventDataMap as by, type WebhookEnvelope as c, type SekyroEnvironment as d, type VerificationAssurance as e, type SessionOutcome as f, type VerificationUnit as g, type SubjectReuseMode as h, type ResultRisk as i, type ResultCheckProofs as j, type ResultDuplicate as k, type FailureIdentification as l, type AgeResult as m, type AmlMatchFlaggedEventData as n, type BlockCheck as o, type BlockCheckInput as p, type BlockDuration as q, type BlockIdNumber as r, type BlockKind as s, type BlockReason as t, BlocksApi as u, type CameraUnavailableCause as v, type CheckState as w, type CheckType as x, type ConnectorIdentity as y, type CreateBlockInput as z };
|