@onfido/api 3.4.0 → 3.6.0

package/README.md

@@ -132,15 +132,15 @@ onfido
 
 ### File download
 
-File downloads, for example `onfido.downloadDocument(documentId, {responseType: 'arraybuffer'})`, will return an instance of a specific object for this endpoint.
+File downloads, for example `onfido.downloadDocument(documentId)`, will return an instance of a `FileTransfer` object.
 
-These objects will have a content type, e.g. `image/png`.
+This object will have a content type, e.g. `image/png`.
 
 ```js
 download.headers["content-type"];
 ```
 
-Call `slice()` to get a `Blob` of the download:
+Call `slice()` to get a `Buffer` of the download:
 
 ```js
 const blob = download.data.slice();
@@ -148,16 +148,18 @@ const blob = download.data.slice();
 
 ### File upload
 
-For some common types of streams, like instances of `fs.ReadStream`, you can provide the stream directly:
+File upload should make use of the provided `FileTransfer` class, e.g.:
 
 ```js
 onfido.uploadDocument(
   "passport",
   "<APPLICANT_ID>",
-  fs.createReadStream("path/to/passport.png")
+  new FileTransfer(Buffer.from(document.buffer), document.filename)
 );
 ```
 
+`FileTransfer` object can also be created from an existing file, e.g. `new FileTransfer("path/to/passport.png")`.
+
 ### Webhook event verification
 
 Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:

package/dist/api.d.ts

@@ -8798,10 +8798,276 @@ export interface WatchlistEnhancedBreakdown {
 export interface WatchlistEnhancedProperties {
     /**
      * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
-     * @type {Array<string>}
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInner>}
      * @memberof WatchlistEnhancedProperties
      */
-    'records'?: Array<string>;
+    'records'?: Array<WatchlistEnhancedPropertiesRecordsInner>;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInner {
+    /**
+     * All addresses on file.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'address'?: Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>;
+    /**
+     * Any names that the person is also known as.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'alias'?: Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>;
+    /**
+     * Any linked persons, for example family relatives or business partners.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'associate'?: Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>;
+    /**
+     * Information about the person, for example hair color or nationality.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'attribute'?: Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>;
+    /**
+     * All the date of births on file.
+     * @type {Array<string>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'date_of_birth'?: Array<string>;
+    /**
+     * Information about events that have occurred to the person, for example deportation or arrest.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'event'?: Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>;
+    /**
+     * The name on file
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'full_name'?: string;
+    /**
+     * The role, country and date of each position.
+     * @type {Array<string>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'position'?: Array<string>;
+    /**
+     * Details about where the information was obtained.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'source'?: Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAddressInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAddressInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'address_line1'?: string;
+    /**
+     *
+     * @type {CountryCodes}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'country'?: CountryCodes;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'postal_code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'state_province'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'town'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'locator_type'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAliasInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAliasInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAliasInner
+     */
+    'alias_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAliasInner
+     */
+    'alias_type'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+     */
+    'entity_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+     */
+    'relationship_direction'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+     */
+    'relationship_type'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+     */
+    'attribute_type'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+     */
+    'attribute_value'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerEventInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerEventInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'category'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'event_date'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'event_description'?: string;
+    /**
+     *
+     * @type {WatchlistEnhancedPropertiesRecordsInnerEventInnerSource}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'source'?: WatchlistEnhancedPropertiesRecordsInnerEventInnerSource;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'sub_category'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_date'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_format'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_url'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerSourceInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerSourceInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_headline'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_url'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_format'?: string;
 }
 /**
  *

package/dist/api.js

@@ -2789,7 +2789,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
                 localVarFormParams.append('validate_image_quality', String(validateImageQuality));
             }
             if (location !== undefined) {
-                localVarFormParams.append('location', new Blob([JSON.stringify(location)], { type: "application/json", }));
+                localVarFormParams.append('location', JSON.stringify(location));
             }
             localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.4.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.6.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/dist/esm/api.d.ts

@@ -8798,10 +8798,276 @@ export interface WatchlistEnhancedBreakdown {
 export interface WatchlistEnhancedProperties {
     /**
      * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
-     * @type {Array<string>}
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInner>}
      * @memberof WatchlistEnhancedProperties
      */
-    'records'?: Array<string>;
+    'records'?: Array<WatchlistEnhancedPropertiesRecordsInner>;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInner {
+    /**
+     * All addresses on file.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'address'?: Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>;
+    /**
+     * Any names that the person is also known as.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'alias'?: Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>;
+    /**
+     * Any linked persons, for example family relatives or business partners.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'associate'?: Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>;
+    /**
+     * Information about the person, for example hair color or nationality.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'attribute'?: Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>;
+    /**
+     * All the date of births on file.
+     * @type {Array<string>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'date_of_birth'?: Array<string>;
+    /**
+     * Information about events that have occurred to the person, for example deportation or arrest.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'event'?: Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>;
+    /**
+     * The name on file
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'full_name'?: string;
+    /**
+     * The role, country and date of each position.
+     * @type {Array<string>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'position'?: Array<string>;
+    /**
+     * Details about where the information was obtained.
+     * @type {Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>}
+     * @memberof WatchlistEnhancedPropertiesRecordsInner
+     */
+    'source'?: Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAddressInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAddressInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'address_line1'?: string;
+    /**
+     *
+     * @type {CountryCodes}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'country'?: CountryCodes;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'postal_code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'state_province'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'town'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAddressInner
+     */
+    'locator_type'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAliasInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAliasInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAliasInner
+     */
+    'alias_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAliasInner
+     */
+    'alias_type'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+     */
+    'entity_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+     */
+    'relationship_direction'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAssociateInner
+     */
+    'relationship_type'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+     */
+    'attribute_type'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerAttributeInner
+     */
+    'attribute_value'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerEventInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerEventInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'category'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'event_date'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'event_description'?: string;
+    /**
+     *
+     * @type {WatchlistEnhancedPropertiesRecordsInnerEventInnerSource}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'source'?: WatchlistEnhancedPropertiesRecordsInnerEventInnerSource;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInner
+     */
+    'sub_category'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_date'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_format'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
+     */
+    'source_url'?: string;
+}
+/**
+ *
+ * @export
+ * @interface WatchlistEnhancedPropertiesRecordsInnerSourceInner
+ */
+export interface WatchlistEnhancedPropertiesRecordsInnerSourceInner {
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_headline'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_url'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WatchlistEnhancedPropertiesRecordsInnerSourceInner
+     */
+    'source_format'?: string;
 }
 /**
  *

package/dist/esm/api.js

@@ -2785,7 +2785,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
                 localVarFormParams.append('validate_image_quality', String(validateImageQuality));
             }
             if (location !== undefined) {
-                localVarFormParams.append('location', new Blob([JSON.stringify(location)], { type: "application/json", }));
+                localVarFormParams.append('location', JSON.stringify(location));
             }
             localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
             setSearchParams(localVarUrlObj, localVarQueryParameter);

package/dist/esm/configuration.js

@@ -29,7 +29,7 @@ export class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.4.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.6.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onfido/api",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "Node.js library for the Onfido API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -45,7 +45,7 @@
     }
   },
   "dependencies": {
-    "axios": "^1.6.1"
+    "axios": "^1.7.4"
   },
   "devDependencies": {
     "@faker-js/faker": "^8.4.1",