@vouchsafe/node 0.1.38 → 0.1.40

package/README.md

@@ -49,8 +49,92 @@ const res = await client.listVerifications({
 const res = await client.getVerification({
   id: "ID",
 })
+
+console.log(res.checks) // Array of verification checks performed
+console.log(res.enrichments) // Array of background checks
+```
+
+### Download artefacts (documents, photos)
+
+Verification responses may include artefact keys. Use these to get pre-signed download URLs:
+
+```ts
+const verification = await client.getVerification({ id: "ID" })
+
+// Get artefact keys from checks
+const photoIdCheck = verification.checks.find((c) => c.step === "photo_id")
+if (photoIdCheck?.artefacts?.[0]) {
+  const artefact = await client.getArtefact({
+    artefact_key: photoIdCheck.artefacts[0].key,
+  })
+
+  console.log(artefact.download_url) // Pre-signed URL (time-limited)
+  console.log(artefact.expires_at) // When the URL expires
+}
+```
+
+### Verify UK immigration status (eVisa)
+
+Verify a person's immigration status, right to work, or right to rent using their Home Office share code:
+
+```ts
+const result = await client.verifyEvisa({
+  sub_type: "ImmigrationStatus", // or 'RightToRent', 'ImmigrationStatus'
+  payload: {
+    reason: "Education or training",
+    job_title: "Software Engineer",
+    company_name: "Sandbox Company",
+    date_of_birth: "1996-06-07",
+    share_code: "PASS12345",
+  },
+})
+
+console.log(result.outcome) // 'pass', 'fail', or 'error'
+
+// Access type-specific fields based on sub_type
+if (result.sub_type === 'ImmigrationStatus') {
+  console.log(result.extracted_details.immigration_status) // e.g., 'Settled'
+}
+
+console.log(result.validations.evisa_exists.status) // 'pass' or 'fail'
 ```
 
+**Sandbox testing**: Use these share codes in sandbox mode:
+
+- `PASS12345` - Returns successful verification
+- `FAIL12345` - Returns failed verification (expired status)
+- `ERROR1234` - Returns error response
+
+### Verify supporting documents
+
+Extract and validate supporting documents like bank statements, utility bills, payslips:
+
+```ts
+import fs from "fs"
+
+const fileBuffer = fs.readFileSync("./bank-statement.pdf")
+const file = new File([fileBuffer], "bank-statement.pdf", {
+  type: "application/pdf",
+})
+
+const result = await client.verifySupportingDocument({
+  document: file,
+  sub_type: "BankStatement",
+  minimum_document_length: 3, // Optional: minimum age in months
+})
+
+console.log(result.outcome) // 'pass', 'fail', or 'error'
+console.log(result.extracted_details.first_name)
+console.log(result.extracted_details.postcode)
+console.log(result.validations.document_age_valid?.status)
+```
+
+**Supported document types**:
+
+- Financial: `BankStatement`, `CreditCardStatement`, `MortgageStatement`, `Payslip`, `PensionAnnualStatement`
+- Utilities: `UtilityBill`, `MobilePhoneBill`
+- Government: `BenefitsLetter`, `HMPPSLetter`, `NHSLetter`
+
 ### List verification flows
 
 ```ts

package/dist/VouchsafeClient.d.ts

@@ -1,4 +1,4 @@
-import { RequestVerificationInput, SmartLookupInput, Status } from "./openapi/models";
+import { RequestVerificationInput, SmartLookupInput, Status, EvisaVerificationInput, SupportingDocumentVerificationResponse } from "./openapi/models";
 interface VouchsafeClientOptions {
     client_id: string;
     client_secret: string;
@@ -17,6 +17,9 @@ export declare class VouchsafeClient {
     private verificationsApi;
     private smartLookupsApi;
     private flowsApi;
+    private artefactsApi;
+    private eVisaVerificationApi;
+    private supportingDocumentVerificationApi;
     constructor(options: VouchsafeClientOptions);
     /**
      * PRIVATE METHODS
@@ -45,6 +48,54 @@ export declare class VouchsafeClient {
     getFlow({ id }: {
         id: string;
     }): Promise<import("./openapi").Flow>;
+    /**
+     * Get a pre-signed download URL for an artefact.
+     *
+     * Exchange an artefact key (returned from other endpoints) for a time-limited
+     * pre-signed URL that can be used to download the file.
+     *
+     * @param artefact_key - The artefact key from verification response
+     * @returns Object with download_url, artefact_key, and expires_at
+     */
+    getArtefact({ artefact_key }: {
+        artefact_key: string;
+    }): Promise<import("./openapi").GetArtefactsResponse>;
+    /**
+     * Verify a person's UK immigration status using their Home Office share code.
+     *
+     * Supported verification types:
+     * - ImmigrationStatus - Check immigration status (e.g., Settled, Skilled Worker)
+     * - RightToWork - Verify right to work in the UK
+     * - RightToRent - Verify right to rent property in the UK
+     *
+     * Sandbox testing: Use these share codes in sandbox mode:
+     * - PASS12345 - Returns successful verification with "Pass" outcome
+     * - FAIL12345 - Returns failed verification (e.g. expired status)
+     * - ERROR1234 - Returns error response
+     *
+     * @param input - eVisa verification input with share_code, date_of_birth, and check_type
+     */
+    verifyEvisa(input: EvisaVerificationInput): Promise<import("./openapi").RightToRentVerificationResponse>;
+    /**
+     * Extract and validate a supporting document.
+     *
+     * Accepts a document file (PDF, JPG, or PNG) and extracts personal identity
+     * information and address details.
+     *
+     * Supported document types (sub_type):
+     * - Payslip, PensionAnnualStatement, BenefitsLetter
+     * - HMPPSLetter, NHSLetter
+     * - BankStatement, CreditCardStatement, MortgageStatement
+     * - UtilityBill, MobilePhoneBill
+     *
+     * @param params - Document file, sub_type, and optional minimum_document_length
+     * @returns Verification response with extracted details and validations
+     */
+    verifySupportingDocument(params: {
+        document: Blob | File;
+        sub_type: string;
+        minimum_document_length?: number;
+    }): Promise<SupportingDocumentVerificationResponse>;
 }
 export {};
 //# sourceMappingURL=VouchsafeClient.d.ts.map

package/dist/VouchsafeClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VouchsafeClient.d.ts","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":"AAKA,OAAO,EAEL,wBAAwB,EACxB,gBAAgB,EAChB,MAAM,EACP,MAAM,kBAAkB,CAAA;AAGzB,UAAU,sBAAsB;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAEjC,UAAU,EAAE,MAAM;IAClB,YAAY,EAAE,OAAO;gBADrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,OAAO,EAC5B,OAAO,CAAC,EAAE,MAAM;CAKnB;AAED,qBAAa,eAAe;IAUd,OAAO,CAAC,OAAO;IAT3B,OAAO,CAAC,KAAK,CAAC,CAAQ;IACtB,OAAO,CAAC,WAAW,CAAC,CAAM;IAC1B,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO,CAAC,iBAAiB,CAAmB;IAC5C,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,eAAe,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAU;gBAEN,OAAO,EAAE,sBAAsB;IAcnD;;;;OAIG;IAGH,OAAO,CAAC,cAAc,CAyBrB;IAGD,OAAO,CAAC,iBAAiB,CAqBxB;IAED;;;;OAIG;IAEG,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;IAMtC,iBAAiB,CAAC,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO;IAMtD,mBAAmB,CAAC,KAAK,EAAE,wBAAwB;IAQnD,kBAAkB,CAAC,KAAK,EAAE,gBAAgB;IAQ1C,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE;IAMjD,SAAS;IAMT,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;CAOrC"}
+{"version":3,"file":"VouchsafeClient.d.ts","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,wBAAwB,EACxB,gBAAgB,EAChB,MAAM,EACN,sBAAsB,EACtB,sCAAsC,EACvC,MAAM,kBAAkB,CAAA;AAGzB,UAAU,sBAAsB;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAEjC,UAAU,EAAE,MAAM;IAClB,YAAY,EAAE,OAAO;gBADrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,OAAO,EAC5B,OAAO,CAAC,EAAE,MAAM;CAKnB;AAED,qBAAa,eAAe;IAad,OAAO,CAAC,OAAO;IAZ3B,OAAO,CAAC,KAAK,CAAC,CAAQ;IACtB,OAAO,CAAC,WAAW,CAAC,CAAM;IAC1B,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO,CAAC,iBAAiB,CAAmB;IAC5C,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,eAAe,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,oBAAoB,CAAsB;IAClD,OAAO,CAAC,iCAAiC,CAAmC;gBAExD,OAAO,EAAE,sBAAsB;IAiBnD;;;;OAIG;IAGH,OAAO,CAAC,cAAc,CAyBrB;IAGD,OAAO,CAAC,iBAAiB,CAqBxB;IAED;;;;OAIG;IAEG,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;IAMtC,iBAAiB,CAAC,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO;IAMtD,mBAAmB,CAAC,KAAK,EAAE,wBAAwB;IAQnD,kBAAkB,CAAC,KAAK,EAAE,gBAAgB;IAQ1C,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE;IAMjD,SAAS;IAMT,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;IAMpC;;;;;;;;OAQG;IACG,WAAW,CAAC,EAAE,YAAY,EAAE,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE;IAM5D;;;;;;;;;;;;;;OAcG;IACG,WAAW,CAAC,KAAK,EAAE,sBAAsB;IAM/C;;;;;;;;;;;;;;OAcG;IACG,wBAAwB,CAAC,MAAM,EAAE;QACrC,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;QACrB,QAAQ,EAAE,MAAM,CAAA;QAChB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,GAAG,OAAO,CAAC,sCAAsC,CAAC;CASpD"}

package/dist/VouchsafeClient.js

@@ -6,6 +6,9 @@ const AuthenticationApi_1 = require("./openapi/apis/AuthenticationApi");
 const VerificationsApi_1 = require("./openapi/apis/VerificationsApi");
 const SmartLookupsApi_1 = require("./openapi/apis/SmartLookupsApi");
 const FlowsApi_1 = require("./openapi/apis/FlowsApi");
+const ArtefactsApi_1 = require("./openapi/apis/ArtefactsApi");
+const EVisaVerificationApi_1 = require("./openapi/apis/EVisaVerificationApi");
+const SupportingDocumentVerificationApi_1 = require("./openapi/apis/SupportingDocumentVerificationApi");
 class VouchsafeApiError extends Error {
     constructor(statusCode, responseBody, message) {
         super(message);
@@ -73,6 +76,9 @@ class VouchsafeClient {
         this.verificationsApi = new VerificationsApi_1.VerificationsApi(this.config);
         this.smartLookupsApi = new SmartLookupsApi_1.SmartLookupsApi(this.config);
         this.flowsApi = new FlowsApi_1.FlowsApi(this.config);
+        this.artefactsApi = new ArtefactsApi_1.ArtefactsApi(this.config);
+        this.eVisaVerificationApi = new EVisaVerificationApi_1.EVisaVerificationApi(this.config);
+        this.supportingDocumentVerificationApi = new SupportingDocumentVerificationApi_1.SupportingDocumentVerificationApi(this.config);
     }
     /**
      * PUBLIC METHODS
@@ -104,6 +110,58 @@ class VouchsafeClient {
     async getFlow({ id }) {
         return this.withErrorHandling(() => this.withErrorHandling(() => this.flowsApi.getFlow({ id })));
     }
+    /**
+     * Get a pre-signed download URL for an artefact.
+     *
+     * Exchange an artefact key (returned from other endpoints) for a time-limited
+     * pre-signed URL that can be used to download the file.
+     *
+     * @param artefact_key - The artefact key from verification response
+     * @returns Object with download_url, artefact_key, and expires_at
+     */
+    async getArtefact({ artefact_key }) {
+        return this.withErrorHandling(() => this.artefactsApi.getArtefacts({ artefactKey: artefact_key }));
+    }
+    /**
+     * Verify a person's UK immigration status using their Home Office share code.
+     *
+     * Supported verification types:
+     * - ImmigrationStatus - Check immigration status (e.g., Settled, Skilled Worker)
+     * - RightToWork - Verify right to work in the UK
+     * - RightToRent - Verify right to rent property in the UK
+     *
+     * Sandbox testing: Use these share codes in sandbox mode:
+     * - PASS12345 - Returns successful verification with "Pass" outcome
+     * - FAIL12345 - Returns failed verification (e.g. expired status)
+     * - ERROR1234 - Returns error response
+     *
+     * @param input - eVisa verification input with share_code, date_of_birth, and check_type
+     */
+    async verifyEvisa(input) {
+        return this.withErrorHandling(() => this.eVisaVerificationApi.verifyEvisa({ evisaVerificationInput: input }));
+    }
+    /**
+     * Extract and validate a supporting document.
+     *
+     * Accepts a document file (PDF, JPG, or PNG) and extracts personal identity
+     * information and address details.
+     *
+     * Supported document types (sub_type):
+     * - Payslip, PensionAnnualStatement, BenefitsLetter
+     * - HMPPSLetter, NHSLetter
+     * - BankStatement, CreditCardStatement, MortgageStatement
+     * - UtilityBill, MobilePhoneBill
+     *
+     * @param params - Document file, sub_type, and optional minimum_document_length
+     * @returns Verification response with extracted details and validations
+     */
+    async verifySupportingDocument(params) {
+        return this.withErrorHandling(() => this.supportingDocumentVerificationApi.verifySupportingDocument({
+            document: params.document,
+            subType: params.sub_type,
+            minimumDocumentLength: params.minimum_document_length?.toString()
+        }));
+    }
 }
 exports.VouchsafeClient = VouchsafeClient;
 //# sourceMappingURL=VouchsafeClient.js.map

package/dist/VouchsafeClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"VouchsafeClient.js","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AACzC,wEAAoE;AACpE,sEAAkE;AAClE,oEAAgE;AAChE,sDAAkD;AAclD,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,YACS,UAAkB,EAClB,YAAqB,EAC5B,OAAgB;QAEhB,KAAK,CAAC,OAAO,CAAC,CAAA;QAJP,eAAU,GAAV,UAAU,CAAQ;QAClB,iBAAY,GAAZ,YAAY,CAAS;QAI5B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;CACF;AATD,8CASC;AAED,MAAa,eAAe;IAU1B,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;QAcnD;;;;WAIG;QAEH,sDAAsD;QAC9C,mBAAc,GAAG,KAAK,IAAqB,EAAE;YACnD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;YACtB,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,YAAY;YAE3C,IACE,IAAI,CAAC,KAAK;gBACV,IAAI,CAAC,WAAW;gBAChB,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,QAAQ,EACrD,CAAC;gBACD,OAAO,IAAI,CAAC,KAAK,CAAA;YACnB,CAAC;YAED,MAAM,QAAQ,GAAsB;gBAClC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;gBACjC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;aAC1C,CAAA;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;gBACzD,iBAAiB,EAAE,QAAQ;aAC5B,CAAC,CAAA;YAEF,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,YAAY,CAAA;YAClC,IAAI,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAEhD,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC,CAAA;QAED,0FAA0F;QAClF,sBAAiB,GAAG,KAAK,EAAK,EAAoB,EAAc,EAAE;YACxE,IAAI,CAAC;gBACH,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,YAAY,QAAQ,EAAE,CAAC;oBACrE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBAChC,uCAAuC;wBACvC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;wBACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;wBAC5B,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;wBAE3B,OAAO,EAAE,EAAE,CAAA;oBACb,CAAC;oBAED,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;oBACxD,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAA;oBACxD,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;gBACjE,CAAC;gBAED,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAA;QArEC,MAAM,QAAQ,GAAG,iCAAiC,CAAA;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAa,CAAC;YAC9B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,cAAc;SACjC,CAAC,CAAA;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC3C,CAAC;IA4DD;;;;OAIG;IAEH,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAkB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAC9C,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAE,MAAM,KAA0B,EAAE;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CACpD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,KAA+B;QACvD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;YACxC,wBAAwB,EAAE,KAAK;SAChC,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAuB;QAC9C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC;YACtC,gBAAgB,EAAE,KAAK;SACxB,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAwB;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CACxD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAkB;QAClC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAC5D,CAAA;IACH,CAAC;CAGF;AAvID,0CAuIC"}
+{"version":3,"file":"VouchsafeClient.js","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AACzC,wEAAoE;AACpE,sEAAkE;AAClE,oEAAgE;AAChE,sDAAkD;AAClD,8DAA0D;AAC1D,8EAA0E;AAC1E,wGAAoG;AAgBpG,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,YACS,UAAkB,EAClB,YAAqB,EAC5B,OAAgB;QAEhB,KAAK,CAAC,OAAO,CAAC,CAAA;QAJP,eAAU,GAAV,UAAU,CAAQ;QAClB,iBAAY,GAAZ,YAAY,CAAS;QAI5B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;CACF;AATD,8CASC;AAED,MAAa,eAAe;IAa1B,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;QAiBnD;;;;WAIG;QAEH,sDAAsD;QAC9C,mBAAc,GAAG,KAAK,IAAqB,EAAE;YACnD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;YACtB,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,YAAY;YAE3C,IACE,IAAI,CAAC,KAAK;gBACV,IAAI,CAAC,WAAW;gBAChB,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,QAAQ,EACrD,CAAC;gBACD,OAAO,IAAI,CAAC,KAAK,CAAA;YACnB,CAAC;YAED,MAAM,QAAQ,GAAsB;gBAClC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;gBACjC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;aAC1C,CAAA;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;gBACzD,iBAAiB,EAAE,QAAQ;aAC5B,CAAC,CAAA;YAEF,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,YAAY,CAAA;YAClC,IAAI,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAEhD,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC,CAAA;QAED,0FAA0F;QAClF,sBAAiB,GAAG,KAAK,EAAK,EAAoB,EAAc,EAAE;YACxE,IAAI,CAAC;gBACH,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,YAAY,QAAQ,EAAE,CAAC;oBACrE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBAChC,uCAAuC;wBACvC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;wBACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;wBAC5B,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;wBAE3B,OAAO,EAAE,EAAE,CAAA;oBACb,CAAC;oBAED,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;oBACxD,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAA;oBACxD,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;gBACjE,CAAC;gBAED,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAA;QAxEC,MAAM,QAAQ,GAAG,iCAAiC,CAAA;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAa,CAAC;YAC9B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,cAAc;SACjC,CAAC,CAAA;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjD,IAAI,CAAC,oBAAoB,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjE,IAAI,CAAC,iCAAiC,GAAG,IAAI,qEAAiC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7F,CAAC;IA4DD;;;;OAIG;IAEH,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAkB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAC9C,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAE,MAAM,KAA0B,EAAE;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CACpD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,KAA+B;QACvD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;YACxC,wBAAwB,EAAE,KAAK;SAChC,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAuB;QAC9C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC;YACtC,gBAAgB,EAAE,KAAK;SACxB,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAwB;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CACxD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAkB;QAClC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAC5D,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,EAA4B;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAC9D,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,CACzE,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,wBAAwB,CAAC,MAI9B;QACC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iCAAiC,CAAC,wBAAwB,CAAC;YAC9D,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO,EAAE,MAAM,CAAC,QAAQ;YACxB,qBAAqB,EAAE,MAAM,CAAC,uBAAuB,EAAE,QAAQ,EAAE;SAClE,CAAC,CACH,CAAA;IACH,CAAC;CACF;AA5MD,0CA4MC"}

package/dist/openapi/apis/EVisaVerificationApi.d.ts

@@ -19,11 +19,11 @@ export interface VerifyEvisaRequest {
  */
 export declare class EVisaVerificationApi extends runtime.BaseAPI {
     /**
-     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK immigration status using their Home Office share code.  This endpoint allows you to verify `immigration status`, `right to work`, or `right to rent` by providing the person\'s share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Verify a person\'s right to work in the UK - `RightToRent` - Verify a person\'s right to rent property in the UK  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  **Date format:** The `expiration_date` and `valid_from` fields are returned as date strings in `yyyy-MM-dd` format (e.g. `\"2027-06-15\"`), or `null` for indefinite statuses such as Settled / ILR.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
+     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK eVisa using their Home Office share code.  This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK  **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed.  **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response.  **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one.  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
      */
     verifyEvisaRaw(requestParameters: VerifyEvisaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvisaVerificationResponse>>;
     /**
-     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK immigration status using their Home Office share code.  This endpoint allows you to verify `immigration status`, `right to work`, or `right to rent` by providing the person\'s share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Verify a person\'s right to work in the UK - `RightToRent` - Verify a person\'s right to rent property in the UK  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  **Date format:** The `expiration_date` and `valid_from` fields are returned as date strings in `yyyy-MM-dd` format (e.g. `\"2027-06-15\"`), or `null` for indefinite statuses such as Settled / ILR.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
+     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK eVisa using their Home Office share code.  This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK  **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed.  **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response.  **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one.  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
      */
     verifyEvisa(requestParameters: VerifyEvisaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvisaVerificationResponse>;
 }

package/dist/openapi/apis/EVisaVerificationApi.js

@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class EVisaVerificationApi extends runtime.BaseAPI {
     /**
-     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK immigration status using their Home Office share code.  This endpoint allows you to verify `immigration status`, `right to work`, or `right to rent` by providing the person\'s share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Verify a person\'s right to work in the UK - `RightToRent` - Verify a person\'s right to rent property in the UK  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  **Date format:** The `expiration_date` and `valid_from` fields are returned as date strings in `yyyy-MM-dd` format (e.g. `\"2027-06-15\"`), or `null` for indefinite statuses such as Settled / ILR.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
+     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK eVisa using their Home Office share code.  This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK  **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed.  **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response.  **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one.  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
      */
     async verifyEvisaRaw(requestParameters, initOverrides) {
         if (requestParameters['evisaVerificationInput'] == null) {
@@ -81,7 +81,7 @@ class EVisaVerificationApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EvisaVerificationResponseFromJSON)(jsonValue));
     }
     /**
-     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK immigration status using their Home Office share code.  This endpoint allows you to verify `immigration status`, `right to work`, or `right to rent` by providing the person\'s share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Verify a person\'s right to work in the UK - `RightToRent` - Verify a person\'s right to rent property in the UK  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  **Date format:** The `expiration_date` and `valid_from` fields are returned as date strings in `yyyy-MM-dd` format (e.g. `\"2027-06-15\"`), or `null` for indefinite statuses such as Settled / ILR.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
+     * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div>  Verify a person\'s UK eVisa using their Home Office share code.  This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service.  **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK  **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed.  **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response.  **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire.  > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds.  **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one.  **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response  > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
      */
     async verifyEvisa(requestParameters, initOverrides) {
         const response = await this.verifyEvisaRaw(requestParameters, initOverrides);

package/dist/openapi/models/ApiVerificationCheck.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Proper discriminated union for Api_VerificationCheck_.
+ * This file is auto-generated by post-processing script.
+ */
+import type { ApiVerificationCheck0 } from './ApiVerificationCheck0';
+import type { ApiVerificationCheck1 } from './ApiVerificationCheck1';
+import type { ApiVerificationCheck2 } from './ApiVerificationCheck2';
+import type { ApiVerificationCheck3 } from './ApiVerificationCheck3';
+import type { ApiVerificationCheck4 } from './ApiVerificationCheck4';
+import type { ApiVerificationCheck5 } from './ApiVerificationCheck5';
+import type { ApiVerificationCheck6 } from './ApiVerificationCheck6';
+import type { ApiVerificationCheck7 } from './ApiVerificationCheck7';
+import type { ApiVerificationCheck8 } from './ApiVerificationCheck8';
+/**
+ * Discriminated union of all Api_VerificationCheck_ types
+ * @export
+ */
+export type ApiVerificationCheck = ApiVerificationCheck0 | ApiVerificationCheck1 | ApiVerificationCheck2 | ApiVerificationCheck3 | ApiVerificationCheck4 | ApiVerificationCheck5 | ApiVerificationCheck6 | ApiVerificationCheck7 | ApiVerificationCheck8;
+export declare function ApiVerificationCheckFromJSON(json: any): ApiVerificationCheck;
+export declare function ApiVerificationCheckFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiVerificationCheck;
+export declare function ApiVerificationCheckToJSON(value: ApiVerificationCheck): any;
+export declare function ApiVerificationCheckToJSONTyped(value: ApiVerificationCheck | undefined, ignoreDiscriminator: boolean): any;
+//# sourceMappingURL=ApiVerificationCheck.d.ts.map

package/dist/openapi/models/ApiVerificationCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiVerificationCheck.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/ApiVerificationCheck.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAYrE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC5B,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,CAAC;AAE1B,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,GAAG,oBAAoB,CAE5E;AAED,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,oBAAoB,CAiC/G;AAED,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,oBAAoB,GAAG,GAAG,CAE3E;AAED,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,oBAAoB,GAAG,SAAS,EAAE,mBAAmB,EAAE,OAAO,GAAG,GAAG,CAgC1H"}

package/dist/openapi/models/ApiVerificationCheck.js

@@ -0,0 +1,91 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Proper discriminated union for Api_VerificationCheck_.
+ * This file is auto-generated by post-processing script.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiVerificationCheckFromJSON = ApiVerificationCheckFromJSON;
+exports.ApiVerificationCheckFromJSONTyped = ApiVerificationCheckFromJSONTyped;
+exports.ApiVerificationCheckToJSON = ApiVerificationCheckToJSON;
+exports.ApiVerificationCheckToJSONTyped = ApiVerificationCheckToJSONTyped;
+const ApiVerificationCheck0_1 = require("./ApiVerificationCheck0");
+const ApiVerificationCheck1_1 = require("./ApiVerificationCheck1");
+const ApiVerificationCheck2_1 = require("./ApiVerificationCheck2");
+const ApiVerificationCheck3_1 = require("./ApiVerificationCheck3");
+const ApiVerificationCheck4_1 = require("./ApiVerificationCheck4");
+const ApiVerificationCheck5_1 = require("./ApiVerificationCheck5");
+const ApiVerificationCheck6_1 = require("./ApiVerificationCheck6");
+const ApiVerificationCheck7_1 = require("./ApiVerificationCheck7");
+const ApiVerificationCheck8_1 = require("./ApiVerificationCheck8");
+function ApiVerificationCheckFromJSON(json) {
+    return ApiVerificationCheckFromJSONTyped(json, false);
+}
+function ApiVerificationCheckFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    if (ignoreDiscriminator) {
+        // If ignoring discriminator, try to parse as first variant
+        return (0, ApiVerificationCheck0_1.ApiVerificationCheck0FromJSON)(json);
+    }
+    // Use discriminator to determine which type to parse
+    switch (json['step']) {
+        case 'video_selfie':
+            return (0, ApiVerificationCheck0_1.ApiVerificationCheck0FromJSON)(json);
+        case 'verify_email':
+            return (0, ApiVerificationCheck1_1.ApiVerificationCheck1FromJSON)(json);
+        case 'verify_phone_number':
+            return (0, ApiVerificationCheck2_1.ApiVerificationCheck2FromJSON)(json);
+        case 'verify_user_details':
+            return (0, ApiVerificationCheck3_1.ApiVerificationCheck3FromJSON)(json);
+        case 'photo_id':
+            return (0, ApiVerificationCheck4_1.ApiVerificationCheck4FromJSON)(json);
+        case 'supporting_document':
+            return (0, ApiVerificationCheck5_1.ApiVerificationCheck5FromJSON)(json);
+        case 'bank_account':
+            return (0, ApiVerificationCheck6_1.ApiVerificationCheck6FromJSON)(json);
+        case 'evisa':
+            return (0, ApiVerificationCheck7_1.ApiVerificationCheck7FromJSON)(json);
+        case 'vouch':
+            return (0, ApiVerificationCheck8_1.ApiVerificationCheck8FromJSON)(json);
+        default:
+            throw new Error(`Unknown step value: ${json['step']}`);
+    }
+}
+function ApiVerificationCheckToJSON(value) {
+    return ApiVerificationCheckToJSONTyped(value, false);
+}
+function ApiVerificationCheckToJSONTyped(value, ignoreDiscriminator) {
+    if (value == null) {
+        return value;
+    }
+    if (ignoreDiscriminator) {
+        // If ignoring discriminator, serialize normally
+    }
+    // Use discriminator to determine which serializer to use
+    switch (value.step) {
+        case 'video_selfie':
+            return (0, ApiVerificationCheck0_1.ApiVerificationCheck0ToJSON)(value);
+        case 'verify_email':
+            return (0, ApiVerificationCheck1_1.ApiVerificationCheck1ToJSON)(value);
+        case 'verify_phone_number':
+            return (0, ApiVerificationCheck2_1.ApiVerificationCheck2ToJSON)(value);
+        case 'verify_user_details':
+            return (0, ApiVerificationCheck3_1.ApiVerificationCheck3ToJSON)(value);
+        case 'photo_id':
+            return (0, ApiVerificationCheck4_1.ApiVerificationCheck4ToJSON)(value);
+        case 'supporting_document':
+            return (0, ApiVerificationCheck5_1.ApiVerificationCheck5ToJSON)(value);
+        case 'bank_account':
+            return (0, ApiVerificationCheck6_1.ApiVerificationCheck6ToJSON)(value);
+        case 'evisa':
+            return (0, ApiVerificationCheck7_1.ApiVerificationCheck7ToJSON)(value);
+        case 'vouch':
+            return (0, ApiVerificationCheck8_1.ApiVerificationCheck8ToJSON)(value);
+        default:
+            throw new Error(`Unknown step value: ${value.step}`);
+    }
+}
+//# sourceMappingURL=ApiVerificationCheck.js.map

package/dist/openapi/models/ApiVerificationCheck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiVerificationCheck.js","sourceRoot":"","sources":["../../../src/openapi/models/ApiVerificationCheck.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;GAGG;;AAqCH,oEAEC;AAED,8EAiCC;AAED,gEAEC;AAED,0EAgCC;AApGD,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AACrG,mEAAqG;AAiBrG,SAAgB,4BAA4B,CAAC,IAAS;IACpD,OAAO,iCAAiC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,SAAgB,iCAAiC,CAAC,IAAS,EAAE,mBAA4B;IACvF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,mBAAmB,EAAE,CAAC;QACxB,2DAA2D;QAC3D,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,qDAAqD;IACrD,QAAQ,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,KAAK,cAAc;YACjB,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,cAAc;YACjB,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,qBAAqB;YACxB,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,qBAAqB;YACxB,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,UAAU;YACb,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,qBAAqB;YACxB,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,cAAc;YACjB,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,OAAO;YACV,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,OAAO;YACV,OAAO,IAAA,qDAA6B,EAAC,IAAI,CAAC,CAAC;QAC7C;YACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC;AAED,SAAgB,0BAA0B,CAAC,KAA2B;IACpE,OAAO,+BAA+B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACvD,CAAC;AAED,SAAgB,+BAA+B,CAAC,KAAuC,EAAE,mBAA4B;IACnH,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,mBAAmB,EAAE,CAAC;QACxB,gDAAgD;IAClD,CAAC;IAED,yDAAyD;IACzD,QAAS,KAAa,CAAC,IAAI,EAAE,CAAC;QAC5B,KAAK,cAAc;YACjB,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,cAAc;YACjB,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,qBAAqB;YACxB,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,qBAAqB;YACxB,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,qBAAqB;YACxB,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,cAAc;YACjB,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,OAAO;YACV,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE,KAAK,OAAO;YACV,OAAO,IAAA,mDAA2B,EAAC,KAA8B,CAAC,CAAC;QACrE;YACE,MAAM,IAAI,KAAK,CAAC,uBAAwB,KAAa,CAAC,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC"}

package/dist/openapi/models/ApiVerificationCheck0.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Vouchsafe API docs
+ * Vouchsafe offers a REST API to conduct operations programmatically.  You can request and manage verifications, as well as perform smart lookups.  To use the API, you need a client ID and secret from the Vouchsafe dashboard. [Sign up here](https://app.vouchsafe.id/) if you haven\'t already.  We also have a [video guide](https://www.youtube.com/playlist?list=PLx6V6SSTMuF_ZNWBPnysvwmdIwboLViE8) showing the basics, as well as [SDKs and libraries](https://help.vouchsafe.id/en/articles/12026847-vouchsafe-sdks-and-libraries) for popular languages.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * Contact: help@vouchsafe.id
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ApiVerificationCheck0Validations } from './ApiVerificationCheck0Validations';
+import type { ApiVerificationCheck0ArtefactsInner } from './ApiVerificationCheck0ArtefactsInner';
+/**
+ *
+ * @export
+ * @interface ApiVerificationCheck0
+ */
+export interface ApiVerificationCheck0 {
+    /**
+     *
+     * @type {Array<ApiVerificationCheck0ArtefactsInner>}
+     * @memberof ApiVerificationCheck0
+     */
+    artefacts: Array<ApiVerificationCheck0ArtefactsInner>;
+    /**
+     *
+     * @type {ApiVerificationCheck0Validations}
+     * @memberof ApiVerificationCheck0
+     */
+    validations: ApiVerificationCheck0Validations;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiVerificationCheck0
+     */
+    created_at?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ApiVerificationCheck0
+     */
+    total_attempts?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiVerificationCheck0
+     */
+    outcome: ApiVerificationCheck0OutcomeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiVerificationCheck0
+     */
+    step: ApiVerificationCheck0StepEnum;
+}
+/**
+ * @export
+ */
+export declare const ApiVerificationCheck0OutcomeEnum: {
+    readonly Pass: "pass";
+    readonly Fail: "fail";
+    readonly InProgress: "in_progress";
+    readonly Error: "error";
+};
+export type ApiVerificationCheck0OutcomeEnum = typeof ApiVerificationCheck0OutcomeEnum[keyof typeof ApiVerificationCheck0OutcomeEnum];
+/**
+ * @export
+ */
+export declare const ApiVerificationCheck0StepEnum: {
+    readonly VideoSelfie: "video_selfie";
+};
+export type ApiVerificationCheck0StepEnum = typeof ApiVerificationCheck0StepEnum[keyof typeof ApiVerificationCheck0StepEnum];
+/**
+ * Check if a given object implements the ApiVerificationCheck0 interface.
+ */
+export declare function instanceOfApiVerificationCheck0(value: object): value is ApiVerificationCheck0;
+export declare function ApiVerificationCheck0FromJSON(json: any): ApiVerificationCheck0;
+export declare function ApiVerificationCheck0FromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiVerificationCheck0;
+export declare function ApiVerificationCheck0ToJSON(json: any): ApiVerificationCheck0;
+export declare function ApiVerificationCheck0ToJSONTyped(value?: ApiVerificationCheck0 | null, ignoreDiscriminator?: boolean): any;
+//# sourceMappingURL=ApiVerificationCheck0.d.ts.map

package/dist/openapi/models/ApiVerificationCheck0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiVerificationCheck0.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/ApiVerificationCheck0.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAO3F,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,uCAAuC,CAAC;AAQjG;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACtD;;;;OAIG;IACH,WAAW,EAAE,gCAAgC,CAAC;IAC9C;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,OAAO,EAAE,gCAAgC,CAAC;IAC1C;;;;OAIG;IACH,IAAI,EAAE,6BAA6B,CAAC;CACvC;AAGD;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;CAKnC,CAAC;AACX,MAAM,MAAM,gCAAgC,GAAG,OAAO,gCAAgC,CAAC,MAAM,OAAO,gCAAgC,CAAC,CAAC;AAEtI;;GAEG;AACH,eAAO,MAAM,6BAA6B;;CAEhC,CAAC;AACX,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC;AAG7H;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,qBAAqB,CAM7F;AAED,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,GAAG,GAAG,qBAAqB,CAE9E;AAED,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,qBAAqB,CAajH;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,GAAG,GAAG,qBAAqB,CAE5E;AAED,wBAAgB,gCAAgC,CAAC,KAAK,CAAC,EAAE,qBAAqB,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CAchI"}