@kyciris/core 1.0.0 → 1.1.1

package/README.md

@@ -114,7 +114,7 @@ This is the part worth getting right.
 | Scope    | The whole project — every identity in it | One end user's verification        |
 | Lives    | On your server                           | In the app or page                 |
 | Header   | `X-API-Key`                              | `x-verification-token`             |
-| Lifetime | Until revoked                            | 8h by default; the gateway decides |
+| Lifetime | Until revoked                            | 10m by default; the gateway decides |
 
 Constructing a client with `apiKey` inside a browser or React Native app
 **throws** (`CREDENTIAL_MISUSE`). A key in a shipped bundle is a key the end

package/dist/index.d.mts

@@ -343,6 +343,66 @@ interface OcrData {
     maritalStatus?: string | null;
     [field: string]: unknown;
 }
+/**
+ * What an applicant still owes, and the verdict about the person.
+ *
+ * A level may require more than one document, which makes "this document is
+ * approved" and "this person is verified" different statements. Only the second
+ * one is what an integration actually wants to act on.
+ */
+type ApplicantAnswer = 'GREEN' | 'RED';
+/**
+ * Whether presenting the document again could change the answer.
+ *
+ * `RETRY` is a bad photo, or a failure on the gateway's side -- ask the user to
+ * try again. `FINAL` is a decision the rules would reach again, so asking them
+ * to retry only wastes their time.
+ */
+type ApplicantRejectType = 'RETRY' | 'FINAL';
+type RequirementStatus = 'APPROVED' | 'REVIEW' | 'REJECTED' | 'PENDING';
+interface ApplicantRequirement {
+    /** One of the document types the level asks for. */
+    documentType: string;
+    status: RequirementStatus;
+    /** The verification that settled it, when one has. */
+    verificationId: string | null;
+    rejectionType: string | null;
+}
+interface ApplicantStatus {
+    identityId: string;
+    externalId: string;
+    /** Decides which of the level's document lists applies. */
+    country: string | null;
+    levelName: string;
+    /** Every required document approved. */
+    complete: boolean;
+    /** Null while nothing has been decided, which must not read as a refusal. */
+    answer: ApplicantAnswer | null;
+    rejectType: ApplicantRejectType | null;
+    rejectLabels: string[];
+    requirements: ApplicantRequirement[];
+    /** Document types with nothing approved yet: what to ask the user for next. */
+    outstanding: string[];
+    selfie: {
+        required: boolean;
+        /** Captured once per applicant and reused for every document. */
+        captured: boolean;
+        capturedAt: string | null;
+    };
+}
+interface GetApplicantParams {
+    /**
+     * The applicant's id in your own system. Required when the client holds an
+     * API key; ignored when it holds a verification token, which already names
+     * one end-user.
+     */
+    externalId?: string;
+    /**
+     * Only needed before the applicant's first verification exists, when there is
+     * no level to read from their history.
+     */
+    levelName?: string;
+}
 interface VerificationStatusResponse {
     verificationId: string;
     status: VerificationStatus;
@@ -1018,6 +1078,20 @@ declare class VerificationsResource {
     getStatus(verificationId: string, options?: {
         signal?: AbortSignal;
     }): Promise<VerificationStatusResponse>;
+    /**
+     * What the applicant still owes, and the verdict about the person.
+     *
+     * `getStatus` answers for one document. On a level asking for two, its
+     * APPROVED is not the answer an integration wants -- the applicant may still
+     * owe the other. This is the call that says which, through `outstanding`.
+     *
+     * Works with a verification token, which reports that token's own end-user
+     * and ignores `externalId`, so an app needs no API key to drive a multi-
+     * document flow.
+     */
+    applicant(params?: GetApplicantParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApplicantStatus>;
     /**
      * Which files exist for a verification.
      *
@@ -1449,4 +1523,4 @@ declare class VerificationFlow {
     private patch;
 }
 
-export { ALL_WEBHOOK_EVENTS, type Analytics, AnalyticsResource, type AnalyticsSeries, type ApiMeta, type ApiResult, type AuthMode, type AvailableMedia, type CatalogCountry, type CreateLevelParams, type CreateWebhookParams, DOCUMENT_CATALOG, DUPLICATE_FIELDS, type DocumentCatalogEntry, type DocumentSide, type DocumentType, type DownloadToken, type DuplicateField, type DuplicateGroup, type DuplicatesByField, type DuplicatesByFields, type FaceCheck, type FetchLike, type FileInput, type FlowOptions, type FlowPhase, type FlowState, GATEWAY_ERROR_CODES, type GatewayErrorCode, HttpClient, type HttpClientConfig, IdentitiesResource, type Identity, type IdentityDocumentStep, type IdentityFields, type IdentitySummary, type ImageMimeType, KycirisClient, type KycirisClientConfig, KycirisError, type KycirisErrorCode, type KycirisErrorInit, type KycirisStorage, LevelsResource, type ListIdentitiesParams, type ListVerificationsParams, MAX_IMAGE_FILE_SIZE, type MediaResource, MediaResourceApi, type NormalizedFile, type OcrData, type OcrProcess, type OcrProcessStatus, type OcrProcessStatusResponse, OcrResource, PIPELINE_EVENT_KINDS, type Page, type PaginationMeta, type PipelineEvent, type PipelineEventKind, type PollCallbacks, type PollOptions, type ProgressOptions, type RequestOptions, type ReviewDecision, type RunOcrParams, SDK_ERROR_CODES, SESSION_STORAGE_KEY, type SdkErrorCode, type SelfieStep, SessionStore, type StartVerificationParams, type StoredSession, TERMINAL_VERIFICATION_STATUSES, type UpdateLevelParams, type UpdateWebhookParams, type UploadOptions, type UploadResult, type UploadStepParams, type UploadStepResult, VERIFICATION_OUTCOMES, VERIFICATION_STATUSES, VerificationFlow, type VerificationLevel, type VerificationLevelDefinition, type VerificationLevelStep, type VerificationListItem, type VerificationOutcome, type VerificationProgress, type VerificationSession, type VerificationStatus, type VerificationStatusResponse, type VerificationStep, type VerificationSummary, type VerificationToken, type VerificationTokenProvider, VerificationsResource, WEBHOOK_EVENT_TYPES, type WaitForResultOptions, type Webhook, type WebhookEventType, type WebhookLogEntry, type WebhookResendResult, type WebhookSubscription, WebhooksResource, createKycirisClient, createMemoryStorage, decodeBase64, detectImageMimeType, encodeBase64, isKycirisError, isNormalizedFile, isReactNative, isRetryableStatus, isSupportedDocumentPair, isTerminalStatus, isUntrustedClient, normalizeFile, pollUntil, prepareFile, supportedCountries, supportedDocumentTypes, toPage };
+export { ALL_WEBHOOK_EVENTS, type Analytics, AnalyticsResource, type AnalyticsSeries, type ApiMeta, type ApiResult, type ApplicantAnswer, type ApplicantRejectType, type ApplicantRequirement, type ApplicantStatus, type AuthMode, type AvailableMedia, type CatalogCountry, type CreateLevelParams, type CreateWebhookParams, DOCUMENT_CATALOG, DUPLICATE_FIELDS, type DocumentCatalogEntry, type DocumentSide, type DocumentType, type DownloadToken, type DuplicateField, type DuplicateGroup, type DuplicatesByField, type DuplicatesByFields, type FaceCheck, type FetchLike, type FileInput, type FlowOptions, type FlowPhase, type FlowState, GATEWAY_ERROR_CODES, type GatewayErrorCode, type GetApplicantParams, HttpClient, type HttpClientConfig, IdentitiesResource, type Identity, type IdentityDocumentStep, type IdentityFields, type IdentitySummary, type ImageMimeType, KycirisClient, type KycirisClientConfig, KycirisError, type KycirisErrorCode, type KycirisErrorInit, type KycirisStorage, LevelsResource, type ListIdentitiesParams, type ListVerificationsParams, MAX_IMAGE_FILE_SIZE, type MediaResource, MediaResourceApi, type NormalizedFile, type OcrData, type OcrProcess, type OcrProcessStatus, type OcrProcessStatusResponse, OcrResource, PIPELINE_EVENT_KINDS, type Page, type PaginationMeta, type PipelineEvent, type PipelineEventKind, type PollCallbacks, type PollOptions, type ProgressOptions, type RequestOptions, type RequirementStatus, type ReviewDecision, type RunOcrParams, SDK_ERROR_CODES, SESSION_STORAGE_KEY, type SdkErrorCode, type SelfieStep, SessionStore, type StartVerificationParams, type StoredSession, TERMINAL_VERIFICATION_STATUSES, type UpdateLevelParams, type UpdateWebhookParams, type UploadOptions, type UploadResult, type UploadStepParams, type UploadStepResult, VERIFICATION_OUTCOMES, VERIFICATION_STATUSES, VerificationFlow, type VerificationLevel, type VerificationLevelDefinition, type VerificationLevelStep, type VerificationListItem, type VerificationOutcome, type VerificationProgress, type VerificationSession, type VerificationStatus, type VerificationStatusResponse, type VerificationStep, type VerificationSummary, type VerificationToken, type VerificationTokenProvider, VerificationsResource, WEBHOOK_EVENT_TYPES, type WaitForResultOptions, type Webhook, type WebhookEventType, type WebhookLogEntry, type WebhookResendResult, type WebhookSubscription, WebhooksResource, createKycirisClient, createMemoryStorage, decodeBase64, detectImageMimeType, encodeBase64, isKycirisError, isNormalizedFile, isReactNative, isRetryableStatus, isSupportedDocumentPair, isTerminalStatus, isUntrustedClient, normalizeFile, pollUntil, prepareFile, supportedCountries, supportedDocumentTypes, toPage };

package/dist/index.d.ts

@@ -343,6 +343,66 @@ interface OcrData {
     maritalStatus?: string | null;
     [field: string]: unknown;
 }
+/**
+ * What an applicant still owes, and the verdict about the person.
+ *
+ * A level may require more than one document, which makes "this document is
+ * approved" and "this person is verified" different statements. Only the second
+ * one is what an integration actually wants to act on.
+ */
+type ApplicantAnswer = 'GREEN' | 'RED';
+/**
+ * Whether presenting the document again could change the answer.
+ *
+ * `RETRY` is a bad photo, or a failure on the gateway's side -- ask the user to
+ * try again. `FINAL` is a decision the rules would reach again, so asking them
+ * to retry only wastes their time.
+ */
+type ApplicantRejectType = 'RETRY' | 'FINAL';
+type RequirementStatus = 'APPROVED' | 'REVIEW' | 'REJECTED' | 'PENDING';
+interface ApplicantRequirement {
+    /** One of the document types the level asks for. */
+    documentType: string;
+    status: RequirementStatus;
+    /** The verification that settled it, when one has. */
+    verificationId: string | null;
+    rejectionType: string | null;
+}
+interface ApplicantStatus {
+    identityId: string;
+    externalId: string;
+    /** Decides which of the level's document lists applies. */
+    country: string | null;
+    levelName: string;
+    /** Every required document approved. */
+    complete: boolean;
+    /** Null while nothing has been decided, which must not read as a refusal. */
+    answer: ApplicantAnswer | null;
+    rejectType: ApplicantRejectType | null;
+    rejectLabels: string[];
+    requirements: ApplicantRequirement[];
+    /** Document types with nothing approved yet: what to ask the user for next. */
+    outstanding: string[];
+    selfie: {
+        required: boolean;
+        /** Captured once per applicant and reused for every document. */
+        captured: boolean;
+        capturedAt: string | null;
+    };
+}
+interface GetApplicantParams {
+    /**
+     * The applicant's id in your own system. Required when the client holds an
+     * API key; ignored when it holds a verification token, which already names
+     * one end-user.
+     */
+    externalId?: string;
+    /**
+     * Only needed before the applicant's first verification exists, when there is
+     * no level to read from their history.
+     */
+    levelName?: string;
+}
 interface VerificationStatusResponse {
     verificationId: string;
     status: VerificationStatus;
@@ -1018,6 +1078,20 @@ declare class VerificationsResource {
     getStatus(verificationId: string, options?: {
         signal?: AbortSignal;
     }): Promise<VerificationStatusResponse>;
+    /**
+     * What the applicant still owes, and the verdict about the person.
+     *
+     * `getStatus` answers for one document. On a level asking for two, its
+     * APPROVED is not the answer an integration wants -- the applicant may still
+     * owe the other. This is the call that says which, through `outstanding`.
+     *
+     * Works with a verification token, which reports that token's own end-user
+     * and ignores `externalId`, so an app needs no API key to drive a multi-
+     * document flow.
+     */
+    applicant(params?: GetApplicantParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<ApplicantStatus>;
     /**
      * Which files exist for a verification.
      *
@@ -1449,4 +1523,4 @@ declare class VerificationFlow {
     private patch;
 }
 
-export { ALL_WEBHOOK_EVENTS, type Analytics, AnalyticsResource, type AnalyticsSeries, type ApiMeta, type ApiResult, type AuthMode, type AvailableMedia, type CatalogCountry, type CreateLevelParams, type CreateWebhookParams, DOCUMENT_CATALOG, DUPLICATE_FIELDS, type DocumentCatalogEntry, type DocumentSide, type DocumentType, type DownloadToken, type DuplicateField, type DuplicateGroup, type DuplicatesByField, type DuplicatesByFields, type FaceCheck, type FetchLike, type FileInput, type FlowOptions, type FlowPhase, type FlowState, GATEWAY_ERROR_CODES, type GatewayErrorCode, HttpClient, type HttpClientConfig, IdentitiesResource, type Identity, type IdentityDocumentStep, type IdentityFields, type IdentitySummary, type ImageMimeType, KycirisClient, type KycirisClientConfig, KycirisError, type KycirisErrorCode, type KycirisErrorInit, type KycirisStorage, LevelsResource, type ListIdentitiesParams, type ListVerificationsParams, MAX_IMAGE_FILE_SIZE, type MediaResource, MediaResourceApi, type NormalizedFile, type OcrData, type OcrProcess, type OcrProcessStatus, type OcrProcessStatusResponse, OcrResource, PIPELINE_EVENT_KINDS, type Page, type PaginationMeta, type PipelineEvent, type PipelineEventKind, type PollCallbacks, type PollOptions, type ProgressOptions, type RequestOptions, type ReviewDecision, type RunOcrParams, SDK_ERROR_CODES, SESSION_STORAGE_KEY, type SdkErrorCode, type SelfieStep, SessionStore, type StartVerificationParams, type StoredSession, TERMINAL_VERIFICATION_STATUSES, type UpdateLevelParams, type UpdateWebhookParams, type UploadOptions, type UploadResult, type UploadStepParams, type UploadStepResult, VERIFICATION_OUTCOMES, VERIFICATION_STATUSES, VerificationFlow, type VerificationLevel, type VerificationLevelDefinition, type VerificationLevelStep, type VerificationListItem, type VerificationOutcome, type VerificationProgress, type VerificationSession, type VerificationStatus, type VerificationStatusResponse, type VerificationStep, type VerificationSummary, type VerificationToken, type VerificationTokenProvider, VerificationsResource, WEBHOOK_EVENT_TYPES, type WaitForResultOptions, type Webhook, type WebhookEventType, type WebhookLogEntry, type WebhookResendResult, type WebhookSubscription, WebhooksResource, createKycirisClient, createMemoryStorage, decodeBase64, detectImageMimeType, encodeBase64, isKycirisError, isNormalizedFile, isReactNative, isRetryableStatus, isSupportedDocumentPair, isTerminalStatus, isUntrustedClient, normalizeFile, pollUntil, prepareFile, supportedCountries, supportedDocumentTypes, toPage };
+export { ALL_WEBHOOK_EVENTS, type Analytics, AnalyticsResource, type AnalyticsSeries, type ApiMeta, type ApiResult, type ApplicantAnswer, type ApplicantRejectType, type ApplicantRequirement, type ApplicantStatus, type AuthMode, type AvailableMedia, type CatalogCountry, type CreateLevelParams, type CreateWebhookParams, DOCUMENT_CATALOG, DUPLICATE_FIELDS, type DocumentCatalogEntry, type DocumentSide, type DocumentType, type DownloadToken, type DuplicateField, type DuplicateGroup, type DuplicatesByField, type DuplicatesByFields, type FaceCheck, type FetchLike, type FileInput, type FlowOptions, type FlowPhase, type FlowState, GATEWAY_ERROR_CODES, type GatewayErrorCode, type GetApplicantParams, HttpClient, type HttpClientConfig, IdentitiesResource, type Identity, type IdentityDocumentStep, type IdentityFields, type IdentitySummary, type ImageMimeType, KycirisClient, type KycirisClientConfig, KycirisError, type KycirisErrorCode, type KycirisErrorInit, type KycirisStorage, LevelsResource, type ListIdentitiesParams, type ListVerificationsParams, MAX_IMAGE_FILE_SIZE, type MediaResource, MediaResourceApi, type NormalizedFile, type OcrData, type OcrProcess, type OcrProcessStatus, type OcrProcessStatusResponse, OcrResource, PIPELINE_EVENT_KINDS, type Page, type PaginationMeta, type PipelineEvent, type PipelineEventKind, type PollCallbacks, type PollOptions, type ProgressOptions, type RequestOptions, type RequirementStatus, type ReviewDecision, type RunOcrParams, SDK_ERROR_CODES, SESSION_STORAGE_KEY, type SdkErrorCode, type SelfieStep, SessionStore, type StartVerificationParams, type StoredSession, TERMINAL_VERIFICATION_STATUSES, type UpdateLevelParams, type UpdateWebhookParams, type UploadOptions, type UploadResult, type UploadStepParams, type UploadStepResult, VERIFICATION_OUTCOMES, VERIFICATION_STATUSES, VerificationFlow, type VerificationLevel, type VerificationLevelDefinition, type VerificationLevelStep, type VerificationListItem, type VerificationOutcome, type VerificationProgress, type VerificationSession, type VerificationStatus, type VerificationStatusResponse, type VerificationStep, type VerificationSummary, type VerificationToken, type VerificationTokenProvider, VerificationsResource, WEBHOOK_EVENT_TYPES, type WaitForResultOptions, type Webhook, type WebhookEventType, type WebhookLogEntry, type WebhookResendResult, type WebhookSubscription, WebhooksResource, createKycirisClient, createMemoryStorage, decodeBase64, detectImageMimeType, encodeBase64, isKycirisError, isNormalizedFile, isReactNative, isRetryableStatus, isSupportedDocumentPair, isTerminalStatus, isUntrustedClient, normalizeFile, pollUntil, prepareFile, supportedCountries, supportedDocumentTypes, toPage };

package/dist/index.js

@@ -1323,6 +1323,25 @@ var VerificationsResource = class {
     });
     return result.data;
   }
+  /**
+   * What the applicant still owes, and the verdict about the person.
+   *
+   * `getStatus` answers for one document. On a level asking for two, its
+   * APPROVED is not the answer an integration wants -- the applicant may still
+   * owe the other. This is the call that says which, through `outstanding`.
+   *
+   * Works with a verification token, which reports that token's own end-user
+   * and ignores `externalId`, so an app needs no API key to drive a multi-
+   * document flow.
+   */
+  async applicant(params = {}, options = {}) {
+    const result = await this.http.request({
+      path: "/verification/applicant",
+      query: { ...params },
+      signal: options.signal
+    });
+    return result.data;
+  }
   /**
    * Which files exist for a verification.
    *