@sekyro/node 0.1.0-rc.1 → 0.1.0-rc.11
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 +120 -0
- package/LICENSE +25 -16
- package/README.md +462 -30
- package/dist/chunk-4JZXIGA6.js +1 -0
- package/dist/chunk-H5TUZAV5.js +1 -0
- package/dist/client-B7_KS_rG.d.cts +1848 -0
- package/dist/client-B7_KS_rG.d.ts +1848 -0
- package/dist/connect/express/index.cjs +1 -0
- package/dist/connect/express/index.d.cts +35 -0
- package/dist/connect/express/index.d.ts +35 -0
- package/dist/connect/express/index.js +1 -0
- package/dist/connect/index.cjs +1 -0
- package/dist/connect/index.d.cts +29 -0
- package/dist/connect/index.d.ts +29 -0
- package/dist/connect/index.js +1 -0
- package/dist/connect/next/index.cjs +1 -0
- package/dist/connect/next/index.d.cts +43 -0
- package/dist/connect/next/index.d.ts +43 -0
- package/dist/connect/next/index.js +1 -0
- package/dist/connector-DHK_cSbs.d.ts +426 -0
- package/dist/connector-S_99xkJf.d.cts +426 -0
- package/dist/index.cjs +1 -308
- package/dist/index.d.cts +340 -270
- package/dist/index.d.ts +340 -270
- package/dist/index.js +1 -272
- package/package.json +42 -12
- package/sbom.cdx.json +194 -0
- package/dist/index.cjs.map +0 -1
- package/dist/index.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,125 @@
|
|
|
1
1
|
# @sekyro/node
|
|
2
2
|
|
|
3
|
+
## 0.1.0-rc.11
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 0dd0208: Type the review decision and failure identification fields of the API. `SessionStep.decision` (`SessionStepDecision`: `source`, `mode`, `votes`, `agreement`, `reasons`, `decidedAt`, `sessionId`) on sessions and on the `steps` of the terminal webhooks; `reasons`, `decision` and the terminal fields on `SessionReviewDecidedEventData`; the new `session.superseded` event (`SessionSupersededEventData`) and the `superseded` session outcome; the reason code types `PriorReviewReason` (`prior_review_approved`, `prior_review_rejected`) and `ReviewOutcomeReason` (`superseded_by_retry`, `review_split`); `failureIdentification` (`FailureIdentification`) on sessions and the terminal webhooks. `verifyResultToken` now returns the `sekyro.decision` claim as `decision` and the `sekyro.failure_identification` claim as `failureIdentification`. The `SubjectsApi` notes describe the `404 subject_not_found` answer for a subject that never passed a verification.
|
|
8
|
+
|
|
9
|
+
## 0.1.0-rc.10
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- c307b12: New `ConnectorOptions.onRevocationUnresolved(event)`: called when Sekyro revokes or deletes a subject and the connector finds no user to clear the claim on. The event (`RevocationUnresolvedEvent`) carries ids only: `subjectId`, `provider` and `reason` (`revoked` or `deleted`), never provider data. It runs after the `revocation_unresolved` log line and telemetry event, in the background; the webhook does not wait for it, and a throw or rejection is caught and reported to `logger` as the new `revocation_handler_failed` event. The provider packages' READMEs and examples show the option.
|
|
14
|
+
- 58359cc: Connector telemetry for the dashboard's Connectors page. `createConnector` sends an `x-sekyro-connector: <provider>/<version>` header on every API call and, after each claim write and each `revocation_unresolved`, posts an id-only event (type, provider, session id, subject id, time; never the claim, a token or user data) in the background with a 2-second timeout and no retry. `telemetry: false` turns both off; custom adapters send nothing. New: `ConnectorOptions.telemetry`, `ProviderAdapter.version`, `SekyroOptions.connector`. The six provider adapters report their package version.
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- ff5cc35: Doc comments: `subjectId` on session views and webhooks, and the result token `sub`, are present only once the subject has passed a verification (the API leaves them out before that).
|
|
19
|
+
|
|
20
|
+
## 0.1.0-rc.9
|
|
21
|
+
|
|
22
|
+
### Minor Changes
|
|
23
|
+
|
|
24
|
+
- ef0b9b2: Person data in one international `subject` (spec 2026-10-31). `SessionSubjectInput` gains `idNumber` (`{ type, issuingCountry, number }`, new `SubjectIdNumber`), `names` (per ISO 15924 script, new `SubjectName`), `email`, `birthPlace`, `sex`, `photo`, `photoDate` and `fetchedAt`; the flow decides whether they are checked or believed. `subject.reuse` takes `{ idNumber }`. `CreatedSession` gains `subjectUse` and `warnings` (one `deprecated_field` entry per deprecated key you sent). `SekyroApiError.retryAfterSeconds` reads the `Retry-After` header (seconds or an HTTP date).
|
|
25
|
+
|
|
26
|
+
Deprecated, still sent as passed: `input.nni`, `input.fullName`, `input.birthDate`, `input.phone`, `input.email`, `input.suppliedIdentity` (`SuppliedIdentityRecord`), `subject.nni`, `subject.documentNumber`, the `nni` and `document` reuse targets, and the flow setting `population_registry.nniSource` (use `idNumberSource`). Reason unions carry each renamed reason under both names (`IdNumberReason`; `PolicyFailureReason` gains `document_id_number_mismatch`).
|
|
27
|
+
|
|
28
|
+
Breaking (pre-1.0): `registryFromAnrpts()` and `RegistryFromAnrptsOptions` are removed. Use `subjectFromNationalRegistry("MR", answer, { fetchedAt })`, which returns the `subject` reference keys (`SubjectRecord`) and throws `SekyroConfigError` `registry_country_unsupported` for a country without a format, and `registry_nationality_unmapped` when the answer states a nationality it cannot map (pass `options.nationality` to map it yourself).
|
|
29
|
+
|
|
30
|
+
## 0.1.0-rc.8
|
|
31
|
+
|
|
32
|
+
### Patch Changes
|
|
33
|
+
|
|
34
|
+
- 22acfcf: Adds the Age check (selfie) types: `AgeMethod` and `AgeResult`, `age` on sessions and on the `session.completed` and `session.failed` webhooks (with `estimate` and `sigma` only when the step's "Keep and show the estimated age" setting is on), `age` on `verifyResultToken` results from the `sekyro.age` claim (the threshold and the method, never the estimate), the `age_estimation` service and its `showEstimatedAge` setting, and the `underage_estimated` reason. Deploy this version before turning on the age check for your organization.
|
|
35
|
+
- 24a22a4: Adds the `usage.threshold_reached` webhook payload type, `UsageThresholdReachedEventData`: sent once when a usage, credit or spend threshold of your plan is reached (`kind`, and when they apply `unit`, `threshold`, `used`, `limit` and `period`).
|
|
36
|
+
|
|
37
|
+
## 0.1.0-rc.7
|
|
38
|
+
|
|
39
|
+
### Minor Changes
|
|
40
|
+
|
|
41
|
+
- 1e450dc: Connect: the `@sekyro/node/connect` subpath (claim contract, `mergeClaim`, `evaluateGate`, `createConnector`) with Express and Next.js gates; `verifyResultToken` accepts several app ids and returns `appId` and `reuseMode`; `sessions.list({ externalRef, status })`; `Subject.level`, `levelAt`, `levelAssurance`, `sessions[].level`; `externalRefs` on subject events; `reuseMode` and `link.state` on session events; the optional `ProviderAdapter.update` for an atomic read-merge-write, and writes for one user serialised in process.
|
|
42
|
+
|
|
43
|
+
### Patch Changes
|
|
44
|
+
|
|
45
|
+
- 3ea3d33: Docs: `listFlows()` now documents that an invalid API key answers `401 unauthorized` (every key belongs to an app; the `key_not_bound` error is gone).
|
|
46
|
+
|
|
47
|
+
## 0.1.0-rc.6
|
|
48
|
+
|
|
49
|
+
### Minor Changes
|
|
50
|
+
|
|
51
|
+
- 8bc8320: `subject.reuse` accepts an identity document: `{ document: { type, issuingCountry, number } }` (`SubjectReuseDocument`; `type` is `national_id`, `passport` or `residence_permit`, `issuingCountry` ISO alpha-2 or alpha-3). Still exactly one target per session.
|
|
52
|
+
|
|
53
|
+
### Patch Changes
|
|
54
|
+
|
|
55
|
+
- 82c4898: `CreateSessionInput.assistedBy` and `Session.assistedBy`: your own reference for the agent filming the person in an assisted-capture flow.
|
|
56
|
+
|
|
57
|
+
## 0.1.0-rc.5
|
|
58
|
+
|
|
59
|
+
### Minor Changes
|
|
60
|
+
|
|
61
|
+
- 82d0799: Sekyro flows: choose the app's flow at session create, override it per session, and read which flow a session ran.
|
|
62
|
+
|
|
63
|
+
- `sessions.create({ flow })`: the app's flow by slug (e.g. `foreigners`) or `flw_` id; absent = the app's default flow.
|
|
64
|
+
- `sessions.create({ overrides })`: `FlowOverrides` with `settings` (eligibility, decisions, data consistency, returning users, documents) and `services` (per-service settings keyed by `ServiceId`, or `'off'` to remove the service). New types `FlowOverrides`, `FlowOverridableSettings`, `FlowServiceSettings`, `ServiceId`.
|
|
65
|
+
- Document substitution is a setting of the `document` and `nfc` services (`documentSubstitution: { mode: 'off' | 'signal' | 'review', failBelow? }`, new type `DocumentSubstitutionSettings`), not of `device_network`. `population_registry.sources` and `national_eid.providers` also accept `'org'` (every registry or national eID your organisation can use).
|
|
66
|
+
- `sekyro.listFlows()` (`GET /api/v2/flows`): the published flows of the key's app as `FlowSummary` (`id`, `slug`, `name`, `version`, `isDefault`).
|
|
67
|
+
- `flow` (`SessionFlowRef`: `id`, `slug`, `version`) on `Session` and on the `session.*` webhook data; `nodeId` and `service` on session steps, webhook step entries and `session.step.completed`; `handled` on session steps (a fallback took over). Checks of a lane the person did not take are not listed.
|
|
68
|
+
- `flow` on `CreatedSession` (the flow version the new session runs); its steps omit the lanes not taken.
|
|
69
|
+
- Errors: `SekyroFlowErrorCode` (`flow_not_found`, `flow_not_published`, `flow_archived`, `override_invalid`, `override_widens_flow`, `reuse_disabled`, and `choice_not_found` / `choice_locked` / `choice_option_unavailable` from `sessions.selectMethod`); `SekyroApiError.code` is typed `SekyroApiErrorCode` (still any string) and `SekyroApiError.details` carries the API's `error.details`. `isFlowError(err, ...codes)` narrows `details` to the code's documented shape (`SekyroFlowErrorDetailsMap`): `issues[]` (`FlowErrorIssue`: `code`, `message`, `path?`, `nodeId?`, `service?`, `field?`), plus `fields` on `override_widens_flow` and `flow { id, slug }` on `flow_not_published`, `flow_archived` and `reuse_disabled`. Missing or unexpected details are not narrowed, never thrown on.
|
|
70
|
+
- `Subject.returningReady` follows the returning-user settings of the app's default flow.
|
|
71
|
+
- **Breaking:** the `profile` override on `sessions.create` is removed, with the `EkycProfileSettings`, `EkycProfileOverride` and `ProfileEmail` types. Use `overrides`.
|
|
72
|
+
|
|
73
|
+
## 0.1.0-rc.4
|
|
74
|
+
|
|
75
|
+
### Minor Changes
|
|
76
|
+
|
|
77
|
+
- 46905f2: National eID (SDK spec §3.2; Houwiyeti in Mauritania): the `eid_auth` check type, the `national_eid` identity method, and the generic `eid` result (`{ provider, country, verifiedAt }`) on the partner session view and the terminal `session.*` webhook data.
|
|
78
|
+
|
|
79
|
+
**Migration (TypeScript):** `CheckType` gains `eid_auth` and `IdentityMethod` gains `national_eid`; webhook/session handlers that switch over them exhaustively need an extra branch. The `eid` field is optional and additive.
|
|
80
|
+
- 7a3f935: Phone OTP channel choice and the email OTP step.
|
|
81
|
+
|
|
82
|
+
- `@sekyro/web`: the phone OTP step lists the channels the person can choose from (`PhoneOtpSnapshot.channels`, WhatsApp first; `[]` on a session created before channel choice). With more than one, `send({ channel })` needs the person's choice — it is never picked for them — and a channel the step doesn't offer is refused locally with the new `OtpInputError` (`channel`, `required` / `unavailable`). `resendAvailableAt` now follows the server's resend time when the session reports one. New `email_otp` step (`EmailOtpStepHandle`: `send({ email })`, `verify(code)`; a malformed address rejects with `OtpInputError("email", "format")`), shown before the identity-method choice like the phone step. New types: `HostedEmailOtpView`, `EmailOtpInput`, `EmailOtpReason`, the `email_otp` check type and the reasons `otp_channel_unavailable`, `otp_destination_not_allowed`, `otp_destination_unknown`, `otp_rate_limited`, `email_invalid`, `email_disposable`.
|
|
83
|
+
- `@sekyro/react`: `PhoneOtpStep` shows one "Send code by …" button per offered channel (WhatsApp first) and a "Resend by …" button per channel after the server's resend time; sessions without channels keep the single "Send code" button. New `EmailOtpStep` (rendered by `SekyroVerification` for the `email_otp` step); its view and ar/fr/en copy load on demand, so apps without an email check don't download them. New copy keys `otp.chooseChannel`, `otp.sendBy`, `otp.resendBy`, the new `otp.reason_*` keys and `emailOtp.*` (overridable through `strings`).
|
|
84
|
+
- `@sekyro/node`: profile `phone.channels` / `phone.destinations`, `email` (`ProfileEmail`: `emailSource`, `disposable`), `attempts.email`, the `input.email` session anchor and the `email_otp` check type.
|
|
85
|
+
- 3ee9ae7: `EkycProfileSettings.portrait`: the live photo's purpose and the new selfie ICAO policy (`icao: { policy: "alert" | "reject" }`). `reject` asks the person to retake a selfie that does not meet the ICAO photo rules; `alert` lets them continue and records the risk signal `icao_non_compliant` on the session.
|
|
86
|
+
- 757f31d: Type `verifiedContacts` (exported `VerifiedContacts`): the full phone number (E.164, with the channel) and email address the person verified in a session, from OTP checks that passed — on `Session` (`sessions.get`), on `session.completed` / `session.failed` webhook data, and on `session.step.completed` for a passed `phone_otp` / `email_otp` check. Partner-only; absent when nothing was verified or after the session's personal data is purged.
|
|
87
|
+
|
|
88
|
+
### Patch Changes
|
|
89
|
+
|
|
90
|
+
- 4c1aa5b: International documents (profile v2 §5.3a): the document type `residence_permit` joins `AcceptedDocumentType` / `ProfileDocumentType`, and `carte_identite` now means a national identity card of any issuing country. `acceptedDocumentTypes` keeps listing only `carte_identite` and `passport`.
|
|
91
|
+
- 9acafe1: NFC chip check (M-nfc). New check type `nfc_chip` (read by the native SDKs only), its reasons (`NfcChipReason`: retryable `chip_read_failed`, `chip_access_denied`, `chip_parse_failed`; final `chip_not_present`, `nfc_unavailable`, `chip_document_mismatch`, `chip_integrity_failed`, `registry_mismatch`, `document_nni_mismatch`, `platform_unsupported`), the error codes `method_not_offered` and `nfc_outcome_not_accepted` (`KNOWN_CODES`), the identity method `document_chip`, the session failure reason `platform_unsupported` and the optional `HostedStepView.nfc` hints (`NfcStepView`). Web behaviour is unchanged: the server skips the chip for web clients or stops the session with `platform_unsupported`; `@sekyro/react`'s method screen never renders the `document_chip` option.
|
|
92
|
+
- 5988b08: Verified subjects (M-nfc): assurance `chip_biometric` (a passed document chip read plus a face match) and reference source `chip` (the chip's DG2 portrait).
|
|
93
|
+
- e229ab3: Add partner-supplied identity data to `sessions.create`: `input.suppliedIdentity` (`SuppliedIdentityRecord`, the person's biographic record and photo, for environments on the `supplied` mode). Add `registryFromAnrpts(response, { fetchedAt })`, a local mapping of an ANRPTS `getPersonne` answer your server already received into that record (`fetchedAt`, when your system received it, is required). Sekyro AI never sees or stores any ANRPTS key. A missing required field throws `SekyroConfigError` with the new code `invalid_registry_record`.
|
|
94
|
+
- 8425e95: Add `sekyro.subjects` — `get(id)`, `list({ externalRef })`, `revoke(id, { reason })` and `delete(id)` (reads need the `subjects:read` scope, revoke / delete the new `subjects:write` scope). Type returning-user sessions (`subject.reuse` at create with exactly one of `subjectId`, `externalRef` or `nni`; `returning: true` + `reuseOf` on the session view and on the session webhook data), the `subject.enrolled` and `subject.deleted` webhook data, and the revocation form of `subject.updated` (`status: 'revoked'`, no session).
|
|
95
|
+
- b6df220: Docs: `sessions.create` in a `supplied` environment now documents `422 supplied_identity_required` (identity data not sent), and that the face on the supplied photo is checked after consent, at the face match (`no_face_reference`), not at create.
|
|
96
|
+
- 471d833: ICAO `id_document` portrait mode (SDK spec §4.9), types and partner helper. New check type `portrait_icao` with its reasons (`PortraitIcaoReason`: `icao_pose`, `icao_eyes`, `icao_mouth`, `icao_occlusion`, `icao_lighting`, `icao_background`, `icao_resolution`, `portrait_not_from_liveness`, all retryable), the per-criterion report (`IcaoReportEntry` on `HostedStepView.icao` and `SessionStepView.report`), `HostedSessionView.portrait` and the `PortraitIcaoInput` submission shape. `@sekyro/node`: `sessions.portrait(id)` returns a 5-minute link to the 480×640 portrait (scope `portrait:read`), `Session.portraitAvailable` and the same flag on the terminal and `review_decided` webhook data. Web behaviour is unchanged: the browser ICAO gate ships later, so the web step model renders `portrait_icao` as "update required".
|
|
97
|
+
- 8425e95: Face-match probe binding (SDK spec §4.10): the server matches the face_match probe against face crops of the scored liveness clip. New retryable, billed `face_match` reason `probe_not_from_liveness` (the face image isn't the person in the liveness clip). `@sekyro/web`: in `FaceMatchReason` and the retryable set (the runner re-captures). `@sekyro/react`: ar/fr/en retry copy "Keep your face in the frame the whole time, then try again"; bundle budget 24 → 25 KiB. `@sekyro/node`: `ProbeBindingReason`. No capture or upload change on any platform.
|
|
98
|
+
- 6b9a2f9: `SessionStep.probeQuality` (new `ProbeQuality` type) on `face_match` steps from `sessions.get` / `sessions.list`: the selfie's measured occlusion, head pose, eye openness and sharpness. Informational only, it never changes the step's state or reason, and it is absent until the platform enables the measurement.
|
|
99
|
+
- 45f639f: Licence: the SDKs are now under the Sekyro AI SDK License of Ibtikar Technologies, Inc. (https://sekyro.ai/en/legal/sdk-license, also in French and Arabic). `package.json#license` is `SEE LICENSE IN LICENSE`, and each package's `LICENSE` summarises the licence and links to it. `@sekyro/web` now also ships `THIRD-PARTY-NOTICES.txt` with the MIT notice of the bundled scanic document detector and the MIT/NCSA notice of the Emscripten glue in its OCR worker.
|
|
100
|
+
|
|
101
|
+
## 0.1.0-rc.3
|
|
102
|
+
|
|
103
|
+
### Patch Changes
|
|
104
|
+
|
|
105
|
+
- 4e7a4a3: Brand: the product is now **Sekyro AI** — package descriptions, READMEs, LICENSE text and the `@sekyro/node` configuration error messages say "Sekyro AI". No API change: package names, the `Sekyro` class, exports and header names are unchanged.
|
|
106
|
+
- c3699fd: Type the end user's `network` (approximate location, operator, VPN/Tor/hosting flags, start IP) and `device` (platform, OS, browser, per-org device keys, signals) on `sessions.get()`, and the same context (without the IP) on `session.completed` / `session.failed` webhook data.
|
|
107
|
+
- 1b6bef2: Profile v2 policy reasons, round 2. New eligibility reason `age_unverifiable` (the app sets a minimum age but the birth date could not be read — `doc_ocr`: retryable with a clearer photo; `population_registry`: final). `failureReason` is widened to every policy reason a session can end on: the session-level reasons plus `nationality_not_allowed`, `underage`, `document_type_not_accepted`, `document_nni_mismatch` and `age_unverifiable`. `@sekyro/web`: `PolicyFailureReason` widened, `age_unverifiable` in `DocReason` / `PopulationReason` / `RETRYABLE_REASONS`. `@sekyro/react`: ar/fr/en copy for `age_unverifiable`. `@sekyro/node`: `EligibilityReason` gains `age_unverifiable`; new `PolicyFailureReason` type used by `Session.failureReason` and the `session.failed` webhook data.
|
|
108
|
+
- 1b6bef2: Profile v2 policy reasons. `@sekyro/web`: the eligibility check reasons `document_type_not_accepted` (retryable), `nationality_not_allowed` and `underage`; `SessionFailureReason` (`location_not_allowed`, `anonymizer_blocked`); `HostedSessionView.failureReason` and `acceptedDocumentTypes`. `@sekyro/react`: ar/fr/en copy for the five reasons. `@sekyro/node`: `SessionFailureReason`, `EligibilityReason`, and `failureReason` on `Session` and the `session.failed` webhook data.
|
|
109
|
+
- 13d512f: Profile v2 step 3: identity-method choice, document-NNI registry submit, matching reasons, `subject` input. `@sekyro/web`: `IdentityMethod`, `MethodChoiceView` and `HostedSessionView.methodChoice`; `HostedStepView.attemptsExhausted` / `nniFromDocument` (and `SessionStepView.attemptsExhausted`); `HostedClient.selectMethod()` (`POST /hosted/method`); error codes `method_required` / `method_locked` / `document_nni_mismatch` (409 when a typed NNI differs from the document's); matching reasons `name_mismatch`, `birth_date_mismatch`, `nationality_mismatch` (doc_ocr + population_registry) and `document_number_mismatch` (doc_ocr) as `MatchReason`. The headless runner stops on a pending choice (`unavailable` / `method_required`, `on('method')`), adds `verification.methodChoice()` / `selectMethod()`, and submits the registry with an empty input when the document gave the NNI. `@sekyro/react`: ar/fr/en copy for the four reasons and the method screen; `<LivenessCapture>` handles the method step while the session waits on the choice: it offers only the methods it can run (the national number — it has no document capture) and selects it without a screen when it is the only one left. `@sekyro/node`: `CreateSessionInput.subject` (`SessionSubjectInput`), `CreateSessionInput.identityMethod` and `sessions.selectMethod(id, method)` (`POST /sessions/:id/method`, `IdentityMethod`) so partners can choose the identity method of an optional-document session, `subjectId` / `externalRef` / `subjectConflict` on `Session` and session webhooks, `SessionStep.attemptsExhausted`, `MatchReason`, and the `subject.updated` webhook data (`{ subjectId, sessionId, status, outcome }`).
|
|
110
|
+
- acbf409: Profile v2 step 4: decision mode, desktop handoff, device stops, per-session profile overrides. `@sekyro/web`: decision-mode reasons `liveness_inconclusive`, `mobile_required`, `match_inconclusive`, `document_authenticity` (`DecisionReason`; the inconclusive three are retryable) and the registered `uncalibrated_capture_channel`; session failure reasons `capture_tampered`, `device_velocity_exceeded`, `device_cooldown`; `HostedStepView.requiresMobile` and `HostedSessionView.retryAfter`; the error code `inference_unavailable` (503, request-level, with `retryAfterSeconds` from `Retry-After` or the body). The headless runner retries `inference_unavailable` up to 3 times after `retryAfterSeconds` (default 10 s) under a fresh idempotency key and a fresh attestation, emitting `on('busy')` for each retry, then surfaces `unavailable / inference_unavailable`; it never captures a `requiresMobile` liveness step on desktop (`unavailable / mobile_required`, nothing uploaded) and adds `verification.mobileRequired()`; a `device_cooldown` result carries `retryAfter`. `@sekyro/react`: ar/fr/en coaching for the inconclusive reasons, "Continue on your phone" instead of the camera when liveness needs a phone, a "busy, trying again" notice, the device stop copy (the cooldown says when to try again — `retryAfterTime()`), no retry button for stops or `mobile_required`; bundle budget 23 → 24 KiB. `@sekyro/node`: `CreateSessionInput.profile` (`EkycProfileOverride`, a deep-partial of `EkycProfileSettings`; unknown keys are rejected server-side, widening answers `403 override_widens_profile` unless the app allows it), `Session.overriddenFields` / `riskSignals` / `retryAfter` (`overriddenFields` and `riskSignals` also on the session lifecycle webhooks), `DecisionReason`, the three device stops in `SessionFailureReason`, and the `subject.suspicious_activity` webhook data (`{ subjectId, sessionId, count }`).
|
|
111
|
+
- 58e220c: Published bundles are now minified and no longer include source maps. The public API and types are unchanged.
|
|
112
|
+
|
|
113
|
+
## 0.1.0-rc.2
|
|
114
|
+
|
|
115
|
+
### Minor Changes
|
|
116
|
+
|
|
117
|
+
- d0dce5e: Breaking (0.x): `sessions.create` no longer takes `flow` or `templateId`. Use an app API key; the app's eKYC profile decides the steps.
|
|
118
|
+
|
|
119
|
+
- Create an app in the Sekyro dashboard, mint an app API key for it, and drop `flow` (or `templateId`) from your `sessions.create` calls.
|
|
120
|
+
- `sessions.create` gains `ttlMinutes` (within the profile's link range, otherwise `400 ttl_out_of_policy`) and `deliver` (`{ channel: "sms" | "whatsapp", to }`, sends the hosted link to the person). The `DeliverOptions` type is exported.
|
|
121
|
+
- Every field is optional, so `sekyro.sessions.create()` is a valid call.
|
|
122
|
+
|
|
3
123
|
## 0.1.0-rc.1
|
|
4
124
|
|
|
5
125
|
### Minor Changes
|
package/LICENSE
CHANGED
|
@@ -1,20 +1,29 @@
|
|
|
1
|
-
Sekyro SDK
|
|
1
|
+
Sekyro AI SDK License (proprietary)
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2026 Ibtikar Technologies. All rights reserved.
|
|
3
|
+
Copyright (c) 2026 Ibtikar Technologies, Inc. All rights reserved.
|
|
4
4
|
|
|
5
|
-
This
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
This SDK is proprietary software of Ibtikar Technologies, Inc., licensed
|
|
6
|
+
only under the Sekyro AI SDK License:
|
|
7
|
+
https://sekyro.ai/en/legal/sdk-license
|
|
8
|
+
(in French: https://sekyro.ai/fr/legal/sdk-license,
|
|
9
|
+
in Arabic: https://sekyro.ai/ar/legal/sdk-license).
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
modify, reverse-engineer, redistribute, sublicense, resell or create
|
|
13
|
-
derivative works of the SDK, nor remove or alter this notice. The source
|
|
14
|
-
code is published for transparency (build provenance, security review); its
|
|
15
|
-
publication grants no additional rights.
|
|
11
|
+
In short, and subject to the full license:
|
|
16
12
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
13
|
+
- You may use the SDK only with a Sekyro AI account, a customer agreement
|
|
14
|
+
with Ibtikar Technologies, Inc. and valid API keys, to integrate the
|
|
15
|
+
Sekyro AI services into your own applications. You may distribute it to
|
|
16
|
+
your end users only as embedded in those applications.
|
|
17
|
+
- You may not use it with another identity verification provider, modify it
|
|
18
|
+
beyond the configuration and theming it exposes, reverse engineer,
|
|
19
|
+
decompile or disassemble it (except where the law expressly allows it),
|
|
20
|
+
circumvent its security, attestation, license checks or usage metering,
|
|
21
|
+
or distribute or sublicense it on its own.
|
|
22
|
+
- Open-source components keep their own licenses. See the third-party
|
|
23
|
+
notices shipped with this SDK.
|
|
24
|
+
- The SDK is provided "as is", without warranty, except as your customer
|
|
25
|
+
agreement provides. The license is governed by the laws of the State of
|
|
26
|
+
Delaware, USA. If this license and your customer agreement conflict,
|
|
27
|
+
the customer agreement prevails.
|
|
28
|
+
|
|
29
|
+
Questions: contact@sekyro.ai
|