@smileid/usesmileid-nodejs 12.0.0 → 12.1.0

package/README.md

@@ -144,6 +144,22 @@ const accepted = await smile.documents.verifyEnhanced({
 });
 ```
 
+### Residency document verification
+
+Verifies a passport and the visa endorsed in it. `idType` is optional and defaults to `PASSPORT`, the only value the API accepts. `visa` is the visa page itself. Results take longer than document verification, so rely on the callback rather than polling. The callback adds an `additional_documents` array with the visa details.
+
+```ts
+const accepted = await smile.documents.verifyResidency({
+  country: 'NG',
+  selfieImage: './selfie.jpg',
+  livenessImages: ['./live1.jpg', './live2.jpg', './live3.jpg', './live4.jpg', './live5.jpg', './live6.jpg'],
+  document: './passport.jpg',
+  visa: './visa.jpg',
+  userDetails,
+  consent,
+});
+```
+
 ### Biometric KYC
 
 ```ts

package/dist/client/client.d.ts

@@ -6,7 +6,7 @@
  * clearFraud convenience wrappers.
  */
 import { type SmileIDConfig } from './config.js';
-import type { AcceptedResponse, AuthenticationParams, BankCodesParams, BankCodesResponse, BiometricKycParams, ClearFraudParams, CompareParams, DocumentVerificationParams, EnhancedDocumentVerificationParams, EnhancedKycParams, FlagFraudParams, IdStatusParams, IdStatusResponse, JobStatus, RegistrationParams, ReplayParams, ReportFraudParams, RequestOptions, SupportedDocumentsParams, SupportedDocumentsResponse, SupportedIdTypesParams, SupportedIdTypesResponse, WaitOptions } from '../generated/models/index.js';
+import type { AcceptedResponse, AuthenticationParams, BankCodesParams, BankCodesResponse, BiometricKycParams, ClearFraudParams, CompareParams, DocumentVerificationParams, EnhancedDocumentVerificationParams, ResidencyDocumentVerificationParams, EnhancedKycParams, FlagFraudParams, IdStatusParams, IdStatusResponse, JobStatus, RegistrationParams, ReplayParams, ReportFraudParams, RequestOptions, SupportedDocumentsParams, SupportedDocumentsResponse, SupportedIdTypesParams, SupportedIdTypesResponse, WaitOptions } from '../generated/models/index.js';
 /** The Smile ID V3 server-side client. */
 export declare class SmileID {
     private readonly transport;
@@ -18,6 +18,7 @@ export declare class SmileID {
     readonly documents: {
         verify(params: DocumentVerificationParams, options?: RequestOptions): Promise<AcceptedResponse>;
         verifyEnhanced(params: EnhancedDocumentVerificationParams, options?: RequestOptions): Promise<AcceptedResponse>;
+        verifyResidency(params: ResidencyDocumentVerificationParams, options?: RequestOptions): Promise<AcceptedResponse>;
     };
     /** Biometric KYC (spec §6.4). */
     readonly biometricKyc: {

package/dist/client/client.js

@@ -89,6 +89,22 @@ class SmileID {
                 }
                 return ops.enhancedDocumentVerification(t, params, options);
             },
+            verifyResidency: (params, options) => {
+                (0, validation_js_1.validateUserDetails)(params.userDetails);
+                // idType defaults to PASSPORT, the only value the API accepts; it also requires the visa image; enforced at
+                // runtime for plain-JavaScript callers too.
+                if (params.idType !== undefined && params.idType !== 'PASSPORT') {
+                    throw new index_js_1.ValidationError({
+                        message: 'idType must be PASSPORT for residency document verification.',
+                    });
+                }
+                if (!params.visa) {
+                    throw new index_js_1.ValidationError({
+                        message: 'visa is required for residency document verification.',
+                    });
+                }
+                return ops.residencyDocumentVerification(t, params, options);
+            },
         };
         this.biometricKyc = {
             verify: (params, options) => {

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

@@ -94,6 +94,23 @@ export interface EnhancedDocumentVerificationParams extends EntryParamsBase {
     /** Sent as the User-ID header. */
     userId?: string;
 }
+/**
+ * documents.verifyResidency → POST /v3/residency_document_verification.
+ * Same as §6.3 plus the visa endorsed in the passport; idType must be PASSPORT.
+ */
+export interface ResidencyDocumentVerificationParams extends EntryParamsBase {
+    selfieImage: BinaryInput;
+    livenessImages: BinaryInput[];
+    document: BinaryInput;
+    documentBack?: BinaryInput;
+    /** The visa page itself (JPEG or PNG), not the passport's biographical page. */
+    visa: BinaryInput;
+    country: string;
+    /** Optional; defaults to PASSPORT, the only value the API accepts. */
+    idType?: 'PASSPORT';
+    /** Sent as the User-ID header. */
+    userId?: string;
+}
 /** biometricKyc.verify (spec §6.4). */
 export interface BiometricKycParams extends EntryParamsBase {
     selfieImage: BinaryInput;

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

@@ -7,10 +7,11 @@
  * 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';
+import { AcceptedResponse, JobStatus, type AuthenticationParams, type BankCodesParams, type BankCodesResponse, type BiometricKycParams, type CompareParams, type DocumentVerificationParams, type EnhancedDocumentVerificationParams, type ResidencyDocumentVerificationParams, 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 residencyDocumentVerification(transport: Transport, params: ResidencyDocumentVerificationParams, 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>;

package/dist/generated/operations/index.js

@@ -11,6 +11,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.enhancedKyc = enhancedKyc;
 exports.documentVerification = documentVerification;
 exports.enhancedDocumentVerification = enhancedDocumentVerification;
+exports.residencyDocumentVerification = residencyDocumentVerification;
 exports.biometricKyc = biometricKyc;
 exports.registration = registration;
 exports.authentication = authentication;
@@ -214,6 +215,35 @@ async function enhancedDocumentVerification(transport, params, opts) {
     });
     return toAccepted(result.json);
 }
+async function residencyDocumentVerification(transport, params, opts) {
+    const parts = [
+        ...scalar('country', params.country),
+        ...scalar('id_type', params.idType ?? 'PASSPORT'),
+        ...scalar('callback_url', effectiveCallback(params.callbackUrl, opts, transport)),
+        await jpegPart('selfie_image', params.selfieImage, 'selfie.jpg'),
+        ...(await livenessParts(params.livenessImages)),
+        await documentPart('document', params.document, 'document.jpg'),
+        ...(params.documentBack
+            ? [await documentPart('document_back', params.documentBack, 'document_back.jpg')]
+            : []),
+        await documentPart('visa', params.visa, 'visa.jpg'),
+        ...jsonPart('user_details', userDetailsJson(params.userDetails)),
+        ...jsonPart('consent', consentJson(params.consent)),
+        ...optionalJson('partner_params', params.partnerParams),
+        ...optionalJson('metadata', params.metadata),
+    ];
+    const result = await transport.execute({
+        method: 'POST',
+        path: '/v3/residency_document_verification',
+        authenticated: true,
+        needsPartnerIdHeader: true,
+        idempotent: false,
+        headers: { 'User-ID': params.userId },
+        multipart: (0, multipart_js_1.buildMultipart)(parts),
+        ...planExtras(opts),
+    });
+    return toAccepted(result.json);
+}
 async function biometricKyc(transport, params, opts) {
     const parts = [
         ...scalar('country', params.country),

package/dist/index.d.ts

@@ -11,6 +11,6 @@ export type { SmileIDConfig, FetchLike } from './client/config.js';
 export { Consent } from './helpers/consent.js';
 export type { ConsentGrantedArgs } from './helpers/consent.js';
 export { AcceptedResponse, JobStatus } from './generated/models/index.js';
-export type { Environment, BinaryInput, RequestOptions, WaitOptions, Consent as ConsentType, UserDetails, PartnerParams, MetadataItem, EnhancedKycParams, DocumentVerificationParams, EnhancedDocumentVerificationParams, BiometricKycParams, RegistrationParams, AuthenticationParams, CompareParams, ComparisonImageType, ReplayParams, FraudReason, ReportFraudParams, FlagFraudParams, ClearFraudParams, BankCodesParams, BankCodesResponse, SupportedIdTypesParams, SupportedIdTypesResponse, SupportedDocumentsParams, SupportedDocumentsResponse, IdStatusParams, IdStatusResponse, } from './generated/models/index.js';
+export type { Environment, BinaryInput, RequestOptions, WaitOptions, Consent as ConsentType, UserDetails, PartnerParams, MetadataItem, EnhancedKycParams, DocumentVerificationParams, EnhancedDocumentVerificationParams, ResidencyDocumentVerificationParams, BiometricKycParams, RegistrationParams, AuthenticationParams, CompareParams, ComparisonImageType, ReplayParams, FraudReason, ReportFraudParams, FlagFraudParams, ClearFraudParams, BankCodesParams, BankCodesResponse, SupportedIdTypesParams, SupportedIdTypesResponse, SupportedDocumentsParams, SupportedDocumentsResponse, IdStatusParams, IdStatusResponse, } from './generated/models/index.js';
 export { SmileIDError, InvalidRequestError, AuthenticationError, PaymentRequiredError, PermissionError, NotFoundError, ConflictError, PayloadTooLargeError, RateLimitError, APIError, ConnectionError, UnexpectedResponseError, TimeoutError, ValidationError, } from './errors/index.js';
 export type { SmileIDErrorFields } from './errors/index.js';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "12.0.0";
+export declare const VERSION = "12.1.0";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '12.0.0';
+exports.VERSION = '12.1.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smileid/usesmileid-nodejs",
-  "version": "12.0.0",
+  "version": "12.1.0",
   "description": "Official Smile ID server-side SDK for JavaScript/TypeScript — V3 APIs.",
   "private": false,
   "type": "commonjs",