@smileid/usesmileid-nodejs 12.0.0

package/dist/generated/models/index.d.ts

@@ -0,0 +1,293 @@
+/**
+ * Wire models and public types (spec §5, §6).
+ *
+ * Generator-owned later: these mirror the request/response shapes and enums.
+ * The public API is camelCase; the wire is always snake_case. The camel↔snake
+ * mapping happens in the operation functions (see ../operations), never here.
+ */
+import type { Readable } from 'node:stream';
+/** Environment selector. Sandbox by default (spec §2.1). */
+export type Environment = 'sandbox' | 'production';
+/**
+ * A binary input. Accepts a filesystem path, a byte buffer, a Blob, or a
+ * readable stream. Wrap it to override the filename or content type on the wire.
+ */
+export type BinaryInput = string | Buffer | Uint8Array | Blob | Readable | {
+    data: string | Buffer | Uint8Array | Blob | Readable;
+    filename?: string;
+    contentType?: string;
+};
+/** Per-request options (spec §4: the last argument to every method). */
+export interface RequestOptions {
+    /** Per-request total timeout in milliseconds. Overrides the client default. */
+    timeout?: number;
+    /** Callback URL override for this request. */
+    callbackUrl?: string;
+    /** An AbortSignal to cancel the request. */
+    signal?: AbortSignal;
+}
+/** Consent block, required on all seven entry endpoints (spec §5.1). */
+export interface Consent {
+    /** Must be true. */
+    granted: true;
+    /** ISO 8601 timestamp. */
+    grantedAt: string;
+    /** ISO 639-1 language code, uppercase (e.g. "EN"). */
+    noticeLanguage: string;
+    /** URL of the privacy notice shown to the user. */
+    noticePrivacyPolicyUrl: string;
+}
+/** Personal details, required on all seven entry endpoints (spec §5.1). */
+export interface UserDetails {
+    givenNames: string;
+    lastName: string;
+    /** At least one of email / phoneNumber is required (validated client-side). */
+    email?: string | null;
+    /** E.164 phone number. At least one of email / phoneNumber is required. */
+    phoneNumber?: string | null;
+}
+/** Free-form partner-supplied key/value pairs (spec §5.1). */
+export type PartnerParams = Record<string, string>;
+/** A single metadata entry (spec §5.1). */
+export interface MetadataItem {
+    name: string;
+    value: string;
+}
+/** Fields shared by the entry endpoints that always carry consent + user details. */
+interface EntryParamsBase {
+    consent: Consent;
+    userDetails: UserDetails;
+    callbackUrl?: string;
+    partnerParams?: PartnerParams;
+    metadata?: MetadataItem[];
+}
+/** enhanced_kyc.verify (spec §6.1). */
+export interface EnhancedKycParams extends EntryParamsBase {
+    country: string;
+    idType: string;
+    idNumber: string;
+    bankCode?: string;
+    operator?: string;
+    /** Sent as the User-ID header. */
+    userId?: string;
+}
+/** documents.verify (spec §6.2). */
+export interface DocumentVerificationParams extends EntryParamsBase {
+    selfieImage: BinaryInput;
+    livenessImages: BinaryInput[];
+    document: BinaryInput;
+    documentBack?: BinaryInput;
+    country: string;
+    /** Optional; auto-classified if omitted. */
+    idType?: string;
+    /** Sent as the User-ID header. */
+    userId?: string;
+}
+/** documents.verifyEnhanced (spec §6.3). Same as §6.2 but idType is required. */
+export interface EnhancedDocumentVerificationParams extends EntryParamsBase {
+    selfieImage: BinaryInput;
+    livenessImages: BinaryInput[];
+    document: BinaryInput;
+    documentBack?: BinaryInput;
+    country: string;
+    idType: string;
+    /** Sent as the User-ID header. */
+    userId?: string;
+}
+/** biometricKyc.verify (spec §6.4). */
+export interface BiometricKycParams extends EntryParamsBase {
+    selfieImage: BinaryInput;
+    livenessImages: BinaryInput[];
+    country: string;
+    idType: string;
+    idNumber: string;
+    sandboxResult?: number;
+    /** Sent as the User-ID header. */
+    userId?: string;
+}
+/** biometric.enroll → POST /v3/registration (spec §6.5). */
+export interface RegistrationParams extends EntryParamsBase {
+    selfieImage: BinaryInput;
+    livenessImages: BinaryInput[];
+    allowNewEnroll?: boolean;
+    sandboxResult?: number;
+    /** Sent as the User-ID header. */
+    userId?: string;
+}
+/** biometric.authenticate (spec §6.6). user_id goes in the BODY (required). */
+export interface AuthenticationParams extends EntryParamsBase {
+    /** Required; must match an enrollee. Serialized as a body field, not a header. */
+    userId: string;
+    /** Required unless useEnrolledImage is true. */
+    selfieImage?: BinaryInput;
+    /** Required unless useEnrolledImage is true. */
+    livenessImages?: BinaryInput[];
+    useEnrolledImage?: boolean;
+    sandboxResult?: number;
+}
+/** Allowed values for compare's comparisonImageType. */
+export type ComparisonImageType = 'DOCUMENT' | 'ID_PHOTO' | 'PORTRAIT';
+/** biometric.compare (spec §6.7). user_id is an optional BODY field. */
+export interface CompareParams extends EntryParamsBase {
+    selfieImage: BinaryInput;
+    comparisonImage: BinaryInput;
+    comparisonImageType: ComparisonImageType;
+    livenessImages?: BinaryInput[];
+    allowNewEnroll?: boolean;
+    /** Optional; serialized as a body field. If set and it passes, enrolls the user. */
+    userId?: string;
+    sandboxResult?: number;
+}
+/** verifications.replay optional body (spec §6.10, corrected to multipart). */
+export interface ReplayParams {
+    callbackUrl?: string;
+}
+/** The nine allowed fraud reasons (spec §6.11). */
+export type FraudReason = 'FIRST_PARTY_FRAUD' | 'SECOND_PARTY_FRAUD' | 'THIRD_PARTY_FRAUD' | 'SYNTHETIC_IDENTITY' | 'ACCOUNT_TAKEOVER' | 'DOCUMENT_FORGERY' | 'IDENTITY_FARMING' | 'MULE_ACCOUNT' | 'OTHER';
+/** users.reportFraud (spec §6.11). */
+export interface ReportFraudParams {
+    isFraud: boolean;
+    /** Email of the reporter. */
+    reportedBy: string;
+    /** Required when isFraud is true. */
+    reason?: FraudReason;
+    /** Required when isFraud is false OR reason is OTHER. Max 500 chars. */
+    notes?: string;
+}
+/** users.flagFraud convenience wrapper params (spec §4). */
+export interface FlagFraudParams {
+    reason: FraudReason;
+    notes?: string;
+    reportedBy: string;
+}
+/** users.clearFraud convenience wrapper params (spec §4). */
+export interface ClearFraudParams {
+    notes: string;
+    reportedBy: string;
+}
+/** services.bankCodes query (spec §6.12). */
+export interface BankCodesParams {
+    country?: string;
+}
+/** services.supportedIdTypes query (spec §6.13). */
+export interface SupportedIdTypesParams {
+    country?: string;
+}
+/** services.supportedDocuments query (spec §6.14). */
+export interface SupportedDocumentsParams {
+    continent?: 'AFRICA' | 'ASIA' | 'EUROPE' | 'NORTH AMERICA' | 'OCEANIA' | 'SOUTH AMERICA';
+    countryCode?: string;
+    locale?: 'en-GB' | 'fr-FR' | 'ar-EG';
+}
+/** services.idStatus query (spec §6.15). */
+export interface IdStatusParams {
+    country: string;
+    idType: string;
+}
+/** Options for verifications.waitUntilComplete (spec §6.9). */
+export interface WaitOptions {
+    /** Poll interval in milliseconds. Default 2000. */
+    interval?: number;
+    /** Overall timeout in milliseconds. Default 60000. */
+    timeout?: number;
+    /** When true (default), a not_found status keeps polling instead of returning. */
+    treatNotFoundAsPending?: boolean;
+    /** Timeout in milliseconds for each individual poll request. */
+    requestTimeout?: number;
+    /** Aborts both the polling loop and any in-flight status request. */
+    signal?: AbortSignal;
+}
+/**
+ * Response to the entry endpoints (HTTP 202) and to replay / report_fraud.
+ *
+ * The wire `status` casing differs by endpoint ("Accepted" vs "accepted");
+ * {@link AcceptedResponse.isAccepted} normalizes it (spec §5.2).
+ */
+export declare class AcceptedResponse {
+    readonly status: string;
+    readonly message: string;
+    readonly jobId: string | null;
+    readonly userId: string | null;
+    readonly createdAt: string | null;
+    constructor(fields: {
+        status: string;
+        message: string;
+        jobId?: string | null;
+        userId?: string | null;
+        createdAt?: string | null;
+    });
+    /** True when the normalized status is "accepted" (case-insensitive). */
+    get isAccepted(): boolean;
+}
+/**
+ * Job status from GET /v3/status (spec §5.2, §6.8).
+ *
+ * `status` is `processing` while the job runs, `not_found` for an unknown job,
+ * and otherwise the terminal decision itself: `clear`, `block`, `attention` or
+ * `error`. `message` carries a human-readable note ("Job completed" on a
+ * finished job) and never the decision.
+ */
+export declare class JobStatus {
+    readonly status: string;
+    readonly jobId: string | null;
+    readonly userId: string | null;
+    readonly message: string | null;
+    constructor(fields: {
+        status: string;
+        jobId?: string | null;
+        userId?: string | null;
+        message?: string | null;
+    });
+    /**
+     * True once the job has reached a terminal decision — any status that is
+     * neither `processing` nor `not_found`. A blank or missing status is not a
+     * decision, so a truncated response never stops the poller.
+     */
+    get isComplete(): boolean;
+    get isProcessing(): boolean;
+    get isNotFound(): boolean;
+}
+/** services.bankCodes response (spec §5.2). */
+export interface BankCodesResponse {
+    bankCodes: {
+        code: string;
+        country: string;
+        name: string;
+    }[];
+}
+/** services.supportedIdTypes response (spec §5.2). */
+export interface SupportedIdTypesResponse {
+    idTypes: {
+        bankCode?: string;
+        country: string;
+        label: string;
+        regex: string;
+        requiredFields: string[];
+        type: string;
+    }[];
+}
+/** services.supportedDocuments response (spec §5.2). */
+export interface SupportedDocumentsResponse {
+    validDocuments: {
+        country: {
+            code: string;
+            name: string;
+            continent: string;
+        };
+        idTypes: {
+            code: string;
+            name: string;
+            example: string[];
+            hasBack: boolean;
+        }[];
+    }[];
+}
+/** services.idStatus response (spec §5.2, §6.15). */
+export interface IdStatusResponse {
+    lastChecked: string;
+    lastCheckStatus: string;
+    lastHourSuccessRate: string;
+    lastKnownStatus: string;
+    lastCheckSuccessRate: string;
+}
+export {};

package/dist/generated/models/index.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * Wire models and public types (spec §5, §6).
+ *
+ * Generator-owned later: these mirror the request/response shapes and enums.
+ * The public API is camelCase; the wire is always snake_case. The camel↔snake
+ * mapping happens in the operation functions (see ../operations), never here.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobStatus = exports.AcceptedResponse = void 0;
+/**
+ * Response to the entry endpoints (HTTP 202) and to replay / report_fraud.
+ *
+ * The wire `status` casing differs by endpoint ("Accepted" vs "accepted");
+ * {@link AcceptedResponse.isAccepted} normalizes it (spec §5.2).
+ */
+class AcceptedResponse {
+    status;
+    message;
+    jobId;
+    userId;
+    createdAt;
+    constructor(fields) {
+        this.status = fields.status;
+        this.message = fields.message;
+        this.jobId = fields.jobId ?? null;
+        this.userId = fields.userId ?? null;
+        this.createdAt = fields.createdAt ?? null;
+    }
+    /** True when the normalized status is "accepted" (case-insensitive). */
+    get isAccepted() {
+        return this.status.toLowerCase() === 'accepted';
+    }
+}
+exports.AcceptedResponse = AcceptedResponse;
+/**
+ * Job status from GET /v3/status (spec §5.2, §6.8).
+ *
+ * `status` is `processing` while the job runs, `not_found` for an unknown job,
+ * and otherwise the terminal decision itself: `clear`, `block`, `attention` or
+ * `error`. `message` carries a human-readable note ("Job completed" on a
+ * finished job) and never the decision.
+ */
+class JobStatus {
+    status;
+    jobId;
+    userId;
+    message;
+    constructor(fields) {
+        this.status = fields.status;
+        this.jobId = fields.jobId ?? null;
+        this.userId = fields.userId ?? null;
+        this.message = fields.message ?? null;
+    }
+    /**
+     * True once the job has reached a terminal decision — any status that is
+     * neither `processing` nor `not_found`. A blank or missing status is not a
+     * decision, so a truncated response never stops the poller.
+     */
+    get isComplete() {
+        return Boolean(this.status) && !this.isProcessing && !this.isNotFound;
+    }
+    get isProcessing() {
+        return this.status === 'processing';
+    }
+    get isNotFound() {
+        return this.status === 'not_found';
+    }
+}
+exports.JobStatus = JobStatus;

package/dist/generated/operations/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Thin per-operation functions (spec §3, §6).
+ *
+ * Generator-owned later: each function takes typed camelCase params, maps them
+ * to the verbatim snake_case wire (headers / query / path / multipart / JSON),
+ * calls the transport, and maps the response back to a public model. All wire
+ * field names are snake_case; the mapping boundary lives here.
+ */
+import type { Transport } from '../../client/transport.js';
+import { AcceptedResponse, JobStatus, type AuthenticationParams, type BankCodesParams, type BankCodesResponse, type BiometricKycParams, type CompareParams, type DocumentVerificationParams, type EnhancedDocumentVerificationParams, type EnhancedKycParams, type IdStatusParams, type IdStatusResponse, type RegistrationParams, type ReportFraudParams, type RequestOptions, type SupportedDocumentsParams, type SupportedDocumentsResponse, type SupportedIdTypesParams, type SupportedIdTypesResponse } from '../models/index.js';
+export declare function enhancedKyc(transport: Transport, params: EnhancedKycParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function documentVerification(transport: Transport, params: DocumentVerificationParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function enhancedDocumentVerification(transport: Transport, params: EnhancedDocumentVerificationParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function biometricKyc(transport: Transport, params: BiometricKycParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function registration(transport: Transport, params: RegistrationParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function authentication(transport: Transport, params: AuthenticationParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function compare(transport: Transport, params: CompareParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function verificationStatus(transport: Transport, jobId: string, opts?: RequestOptions): Promise<JobStatus>;
+export declare function replayCallback(transport: Transport, jobId: string, params?: {
+    callbackUrl?: string;
+}, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function reportFraud(transport: Transport, userId: string, params: ReportFraudParams, opts?: RequestOptions): Promise<AcceptedResponse>;
+export declare function bankCodes(transport: Transport, params?: BankCodesParams, opts?: RequestOptions): Promise<BankCodesResponse>;
+export declare function supportedIdTypes(transport: Transport, params?: SupportedIdTypesParams, opts?: RequestOptions): Promise<SupportedIdTypesResponse>;
+export declare function supportedDocuments(transport: Transport, params?: SupportedDocumentsParams, opts?: RequestOptions): Promise<SupportedDocumentsResponse>;
+export declare function idStatus(transport: Transport, params: IdStatusParams, opts?: RequestOptions): Promise<IdStatusResponse>;