@notabene/javascript-sdk 2.10.0 → 2.11.0-next.2

package/dist/notabene.js

@@ -1,8 +1,8 @@
 var v = Object.defineProperty;
 var g = (t, e, n) => e in t ? v(t, e, { enumerable: !0, configurable: !0, writable: !0, value: n }) : t[e] = n;
 var a = (t, e, n) => g(t, typeof e != "symbol" ? e + "" : e, n);
-var A = /* @__PURE__ */ ((t) => (t.PRIVATE = "WALLET", t.VASP = "VASP", t))(A || {}), y = /* @__PURE__ */ ((t) => (t.NATURAL = "natural", t.LEGAL = "legal", t.SELF = "self", t))(y || {}), I = /* @__PURE__ */ ((t) => (t.EMPTY = "empty", t.VERIFY = "verify", t.PENDING = "pending", t.VERIFIED = "verified", t.BANNED = "banned", t))(I || {}), N = /* @__PURE__ */ ((t) => (t.ALLOWED = "allowed", t.PENDING = "pending", t))(N || {}), L = /* @__PURE__ */ ((t) => (t.ASSET = "asset", t.DESTINATION = "destination", t.COUNTERPARTY = "counterparty", t.AGENT = "agent", t))(L || {}), l = /* @__PURE__ */ ((t) => (t.COMPLETE = "complete", t.RESIZE = "resize", t.RESULT = "result", t.READY = "ready", t.INVALID = "invalid", t.ERROR = "error", t.CANCEL = "cancel", t.WARNING = "warning", t.INFO = "info", t))(l || {}), b = /* @__PURE__ */ ((t) => (t.SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE", t.WALLET_CONNECTION_FAILED = "WALLET_CONNECTION_FAILED", t.WALLET_NOT_SUPPORTED = "WALLET_NOT_SUPPORTED", t.TOKEN_INVALID = "TOKEN_INVALID", t))(b || {}), E = /* @__PURE__ */ ((t) => (t.UPDATE = "update", t.REQUEST_RESPONSE = "requestResponse", t))(E || {}), C = /* @__PURE__ */ ((t) => (t.PENDING = "pending", t.FAILED = "rejected", t.FLAGGED = "flagged", t.VERIFIED = "verified", t))(C || {}), U = /* @__PURE__ */ ((t) => (t.SelfDeclaration = "self-declaration", t.SIWE = "siwe", t.SIWX = "siwx", t.EIP191 = "eip-191", t.EIP712 = "eip-712", t.EIP1271 = "eip-1271", t.BIP137 = "bip-137", t.BIP322 = "bip-322", t.BIP137_XPUB = "xpub", t.TIP191 = "tip-191", t.ED25519 = "ed25519", t.XRP_ED25519 = "xrp-ed25519", t.XLM_ED25519 = "xlm-ed25519", t.CIP8 = "cip-8", t.MicroTransfer = "microtransfer", t.Screenshot = "screenshot", t.Connect = "connect", t))(U || {});
-class _ {
+var A = /* @__PURE__ */ ((t) => (t.PRIVATE = "WALLET", t.VASP = "VASP", t))(A || {}), I = /* @__PURE__ */ ((t) => (t.NATURAL = "natural", t.LEGAL = "legal", t.SELF = "self", t))(I || {}), y = /* @__PURE__ */ ((t) => (t.EMPTY = "empty", t.VERIFY = "verify", t.PENDING = "pending", t.VERIFIED = "verified", t.BANNED = "banned", t))(y || {}), N = /* @__PURE__ */ ((t) => (t.ALLOWED = "allowed", t.PENDING = "pending", t))(N || {}), L = /* @__PURE__ */ ((t) => (t.ASSET = "asset", t.DESTINATION = "destination", t.COUNTERPARTY = "counterparty", t.AGENT = "agent", t))(L || {}), l = /* @__PURE__ */ ((t) => (t.COMPLETE = "complete", t.RESIZE = "resize", t.RESULT = "result", t.READY = "ready", t.INVALID = "invalid", t.ERROR = "error", t.CANCEL = "cancel", t.WARNING = "warning", t.INFO = "info", t))(l || {}), C = /* @__PURE__ */ ((t) => (t.SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE", t.WALLET_CONNECTION_FAILED = "WALLET_CONNECTION_FAILED", t.WALLET_NOT_SUPPORTED = "WALLET_NOT_SUPPORTED", t.TOKEN_INVALID = "TOKEN_INVALID", t))(C || {}), p = /* @__PURE__ */ ((t) => (t.UPDATE = "update", t.REQUEST_RESPONSE = "requestResponse", t))(p || {}), b = /* @__PURE__ */ ((t) => (t.PENDING = "pending", t.FAILED = "rejected", t.FLAGGED = "flagged", t.VERIFIED = "verified", t))(b || {}), U = /* @__PURE__ */ ((t) => (t.SelfDeclaration = "self-declaration", t.SIWE = "siwe", t.SIWX = "siwx", t.SOL_SIWX = "sol-siwx", t.EIP191 = "eip-191", t.EIP712 = "eip-712", t.EIP1271 = "eip-1271", t.BIP137 = "bip-137", t.BIP322 = "bip-322", t.BIP137_XPUB = "xpub", t.TIP191 = "tip-191", t.ED25519 = "ed25519", t.XRP_ED25519 = "xrp-ed25519", t.XLM_ED25519 = "xlm-ed25519", t.CIP8 = "cip-8", t.COSMOS = "cosmos-ecdsa", t.MicroTransfer = "microtransfer", t.Screenshot = "screenshot", t.Connect = "connect", t.CONCORDIUM = "concordium", t))(U || {});
+class O {
   constructor() {
     a(this, "listeners", /* @__PURE__ */ new Map());
     a(this, "port");
@@ -68,7 +68,7 @@ class _ {
     this.port && this.port.postMessage(e);
   }
 }
-class x {
+class _ {
   /**
    * Creates an instance of EmbeddedComponent.
    * @param url - The URL of the embedded component
@@ -82,7 +82,7 @@ class x {
     a(this, "iframe");
     a(this, "eventManager");
     a(this, "modal");
-    this._url = e, this._value = n, this._options = s, this.eventManager = new _(), this.on(l.INVALID, (r) => {
+    this._url = e, this._value = n, this._options = s, this.eventManager = new O(), this.on(l.INVALID, (r) => {
       r.type === l.INVALID && (this._errors = r.errors, this._value = r.value);
     }), this.on(l.RESIZE, (r) => {
       r.type === l.RESIZE && this.iframe && (this.iframe.style.height = `${r.height}px`);
@@ -166,7 +166,7 @@ class x {
    * @param value - The new transaction value
    */
   update(e, n) {
-    this._value = e, n && (this._options = n), this.send({ type: E.UPDATE, value: e, options: this._options });
+    this._value = e, n && (this._options = n), this.send({ type: p.UPDATE, value: e, options: this._options });
   }
   /**
    * Waits for the component to complete and returns the transaction response
@@ -237,7 +237,7 @@ class x {
     });
   }
 }
-function R(t) {
+function x(t) {
   return Object.entries(t).map(([e, n]) => {
     if (n == null) return;
     const s = encodeURIComponent(e), r = encodeURIComponent(
@@ -247,7 +247,7 @@ function R(t) {
     return `${s}=${r}`;
   }).filter((e) => e !== void 0).join("&");
 }
-function O(t) {
+function D(t) {
   const e = t.slice(1);
   return e ? e.split("&").filter(Boolean).reduce(
     (s, r) => {
@@ -257,7 +257,7 @@ function O(t) {
     {}
   ) : {};
 }
-async function p(t, e) {
+async function E(t, e) {
   const n = JSON.stringify(t), s = new TextEncoder(), r = e ? m(e) : crypto.getRandomValues(new Uint8Array(32)), i = await crypto.subtle.importKey(
     "raw",
     r,
@@ -344,7 +344,7 @@ class M {
    * @returns Promise resolving to connection details including ID, version, and encryption key
    */
   async create(e, n) {
-    const s = await p(e), r = {
+    const s = await E(e), r = {
       metadata: n,
       sealed: s.ciphertext
     }, i = await fetch(this.endpoint, {
@@ -377,7 +377,7 @@ class M {
    * @returns Promise resolving to updated connection details including new encryption key
    */
   async update(e, n, s, r, i) {
-    const o = await p(n, i), c = {
+    const o = await E(n, i), c = {
       sealed: o.ciphertext,
       version: s,
       status: r
@@ -466,7 +466,7 @@ class k {
   componentUrl(e, n, s, r) {
     const i = new URL(this.uxUrl);
     i.pathname = e;
-    const o = R({
+    const o = x({
       authToken: this.authToken,
       value: n,
       configuration: s
@@ -484,7 +484,7 @@ class k {
    * @internal
    */
   createComponent(e, n, s, r) {
-    return new x(
+    return new _(
       this.componentUrl(e, n, s, r),
       n,
       s
@@ -562,16 +562,16 @@ export {
   A as AgentType,
   l as CMType,
   M as ConnectionManager,
-  x as EmbeddedComponent,
-  b as ErrorIdentifierCode,
-  E as HMType,
-  y as PersonType,
-  C as ProofStatus,
+  _ as EmbeddedComponent,
+  C as ErrorIdentifierCode,
+  p as HMType,
+  I as PersonType,
+  b as ProofStatus,
   U as ProofTypes,
-  I as Status,
+  y as Status,
   N as VASPSearchControl,
   L as ValidationSections,
-  O as decodeFragmentToObject,
+  D as decodeFragmentToObject,
   k as default,
   S as getRefreshResult
 };

package/docs/README.md

@@ -47,6 +47,11 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
     - [Parameters](#parameters-2)
   - [Deposit Assist](#deposit-assist)
     - [Parameters](#parameters-3)
+  - [Counterparty Assist](#counterparty-assist)
+    - [Use Cases](#use-cases)
+    - [Counterparty Assist Configuration](#counterparty-assist-configuration)
+    - [Component Response](#component-response)
+    - [Retrieving Completed Data](#retrieving-completed-data)
   - [Error handling](#error-handling)
       - [Error reference](#error-reference)
   - [Transaction parameters](#transaction-parameters)
@@ -67,6 +72,7 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
     - [Counterparty Field Properties](#counterparty-field-properties)
       - [Full Example](#full-example)
       - [Field reference](#field-reference)
+    - [Configure Counterparty Assist](#counterparty-assist-configuration)
   - [Locales](#locales)
   - [Theming](#theming)
   - [License](#license)
@@ -301,6 +307,10 @@ const withdrawal = notabene.createWithdrawalAssist({
     currency: 'USD', // ISO currency code
     price: 1700.12, // Asset price
   },
+  customer: {
+    name: 'John Smith',
+    email: "john.smith@domain.com",
+  },
 });
 ```
 
@@ -310,6 +320,7 @@ const withdrawal = notabene.createWithdrawalAssist({
 - `destination`: The destination or blockchain address for the withdrawal. See [Destination](#destination)
 - `amountDecimal`: The amount to transfer in decimal format. See [Transaction Amount](#transaction-amount)
 - `assetPrice`: Optional price information in a fiat currency. See [Asset Price](#asset-price)
+- `customer`: Optional Customer object containing their name and email
 
 If any of the required parameters are missing the component will just show the Notabene badge.
 
@@ -327,6 +338,10 @@ const withdrawal = notabene.createWithdrawalAssist(
       currency: 'USD', // ISO currency code
       price: 1700.12, // Asset price
     },
+    customer: {
+      name: 'John Smith',
+      email: "john.smith@domain.com",
+    },
   },
   {
     proofs: {
@@ -346,6 +361,10 @@ See [Transaction Options](#transaction-options)
 
 The Connect Wallet component helps you collect and verify the address of your users self-hosted wallet in one go.
 
+### Parameters
+
+- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+
 ```js
 const connect = notabene.createConnectWallet({
   asset: 'ETH',
@@ -354,37 +373,12 @@ const connect = notabene.createConnectWallet({
 const { proof, txCreate } = await connect.openModal();
 ```
 
-### Parameters
-
-- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
-
-### Configuration Options
-
-Include configuration Options as a second optional parameter:
-
-```js
-const connect = notabene.createConnectWallet(
-  {
-    asset: 'ETH',
-  },
-  {
-    proofs: {
-      microTransfer: {
-        destination: '0x...',
-        amountSubunits: '12344',
-        timeout: 86440,
-      },
-    },
-  },
-);
-```
-
 ## Deposit Request
 
 The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.
 
 ```js
-const withdrawal = notabene.createDepositRequest({
+const depositRequest = notabene.createDepositRequest({
   asset: 'ETH',
   destination: '0x...',
   amountDecimal: 1.23,
@@ -398,7 +392,7 @@ const withdrawal = notabene.createDepositRequest({
 
 - `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
 - `destination`: The destination or blockchain address for the withdrawal. See [Destination](#destination)
-- `amountDecimal`: The amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
+- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
 - `customer`: Optional Customer object containing their name
 
 If any of the required parameters are missing the component will just show the Notabene badge.
@@ -425,7 +419,7 @@ const deposit = notabene.createDepositAssist(
 ### Parameters
 
 - `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
-- `source`: The source or blockchain address for the deposit. See [Source](#source)
+- `source`: The source or blockchain address for the deposit. See [Origin](#origin)
 - `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
 - `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
 - `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
@@ -434,6 +428,186 @@ If any of the required parameters are missing the component will just show the N
 
 ---
 
+## Counterparty Handoff
+
+**Counterparty Assist** is a feature built into the existing **Withdrawal** and **Deposit Assist** components. When enabled, it allows users to hand off data collection to a counterparty — or to another device — by sharing a secure link. This helps ensure more accurate and complete information, especially when the counterparty is best suited to provide the required data.
+
+This feature does not function as a standalone component. Instead, it augments the Withdrawal and Deposit flows when configured.
+
+### Use Cases
+
+#### Third Parties (`natural`, `legal`)
+
+During the counterparty data collection step, users can generate and share a link to allow third-party counterparties (individuals or organizations) to enter their own data. This ensures data accuracy and supports robust address verification by allowing the rightful owner to provide the necessary information.
+
+#### First Parties (`self`)
+
+During the address verification step, users can share a link to complete self-hosted wallet proof submissions on another device. This is especially useful if the original device used to initiate the process doesn't support signing or wallet access.
+
+### Counterparty Assist Configuration
+
+You can enable **Counterparty Assist** by specifying the counterparty types you want the feature to apply to using the counterpartyAssist configuration field.
+
+- `false`: Disable the feature explicitly
+- `undefined` (not configured): Feature is disabled by default
+- `{ counterpartyTypes: [PersonType.SELF, PersonType.NATURAL, PersonType.LEGAL] }`: Enable for specific counterparty types
+
+**Example Config**
+
+```js
+import Notabene, {
+  PersonType,
+} from '@notabene/javascript-sdk';
+
+// Counterparty assist is enabled for specific counterparty types
+const options: TransactionOptions = {
+  ...
+  counterpartyAssist: {
+    counterpartyTypes: [
+      PersonType.LEGAL,   // JS: 'legal'
+      PersonType.NATURAL, // JS: 'natural'
+      PersonType.SELF,    // JS: 'self'
+    ],
+  }
+};
+```
+
+### Component Response
+
+The component emits a response once a participant has completed their portion of the process. Depending on the party type — **Third Party** (`natural`, `legal`) or **First Party** (`self`) — the behavior and expectations differ slightly.
+
+#### Third Parties (`natural`, `legal`)
+
+When a third party completes their step after following the shared link, the host application will receive a **`COMPLETE`** message from the component. However, because not all required data may be available at this point, the `response` object will include the information gathered so far, along with a `refreshSource` field. This allows the host to fetch the latest encrypted data once it's available.
+
+##### Refresh Source Fields
+
+| Field | Type   | Description                                                                                      |
+|-------|--------|--------------------------------------------------------------------------------------------------|
+| `url` | URI    | The endpoint where the host can retrieve the encrypted data.                                     |
+| `key` | string | The encryption key used to decrypt the PII (Personally Identifiable Information). Not stored by Notabene. |
+
+**Example Response**
+
+```js
+{
+  type: CMType.COMPLETE, // 'complete'
+  response: { // transaciton data + refresh source
+    destination: "0xFf9A04788972C3803959454ECAE1ed327826a216",
+    asset: "eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+      customer: {
+        type: "natural",
+        name: "sdfsd",
+        email: "sdjlf@sdlfj.com"
+      },
+    amountDecimal: 100,
+    counterparty: {
+      type: "natural"
+    },
+    account: {
+      caip10: "eip155:1:0xFf9A04788972C3803959454ECAE1ed327826a216",
+      blockchainAddress: "0xFf9A04788972C3803959454ECAE1ed327826a216",
+      chain: "eip155:1",
+      did: "did:pkh:eip155:1:0xFf9A04788972C3803959454ECAE1ed327826a216",
+      valid: true
+    },
+    refreshSource: {
+      url: "https://safe-connections.notabene.id/17f76e4c-9a2a-4c34-afcb-b4868e609a96", // endpoint to retreive data
+      key: "1Lcp5SFhaMHH7CAEILrS8IWA6BXS4tFZunPx08WU5Ok=" // key that can be used to decrypt data
+    }
+  }
+}
+```
+
+#### First Parties (`self`)
+
+When the user is the originator (i.e., acting on their own behalf), they complete the verification process via a shared link and are then prompted to return to the original page to continue.
+
+Upon completion, the component emits a **`COMPLETE`** response. In this case, the component handles all necessary data updates internally, so **no additional action is required from the host** to retrieve updated data. The host can directly proceed to submit the transfer to the Notabene API.
+
+### Retrieving Completed Data  
+**(Third Parties Only: `natural`, `legal`)**
+
+When data submission is handed off to third parties, we cannot predict how long it will take them to complete the process. For this reason, we provide the host with all the information needed to retrieve the data and allow them to design how the user experiences this flow.
+
+To simplify retrieval and decryption, we provide an asynchronous [`getRefreshResult`](_media/getRefreshResult.md) function. It accepts a `refreshSource` and returns information about the associated transaction. 
+
+**Example**
+
+```js
+import { getRefreshResult } from "@notabene/javascript-sdk";
+
+const transaction = await getRefreshResult({
+  url: "https://safe-connections.notabene.id/17f76e4c-9a2a-4c34-afcb-b4868e609a96",
+  key: "1Lcp5SFhaMHH7CAEILrS8IWA6BXS4tFZunPx08WU5Ok="
+})
+```
+
+#### Response from `getRefreshResult`
+
+| **Property** | **Type**                              | **Optional?** | **Description**                                                                 |
+|--------------|---------------------------------------|---------------|---------------------------------------------------------------------------------|
+| `id`         | `UUID`                                | No            | Unique identifier for the transaction.                                          |
+| `metadata`   | `ConnectionMetadata`                  | No            | Metadata associated with the transaction.                                       |
+| `status`     | `'active'` \| `'completed'` \| `'closed'` | No         | Current status of the transaction’s data collection.                           |
+| `tx`         | `T`                                   | Yes           | Ongoing transaction data (available when status is `active`).                   |
+| `result`     | `TransactionResponse<T>`              | Yes           | Finalized transaction data (available when status is `completed`).             |
+
+**Example Active Transaction Data**
+
+```js
+{
+  "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
+  "metadata": {
+    "participants": [
+      "did:ethr:0x54b75d2a0925508682e65194cccb6f1e8eaafb2c"
+    ],
+    "nodeUrl": "https://api-qa.eu.notabene.id",
+    "transactionType": "withdraw"
+  },
+  "status": "active",
+  "tx": {
+    //...
+  }
+}
+```
+
+**Example Completed Transaction Data**
+
+```js
+{
+  "id": "17f76e4c-9a2a-4c34-afcb-b4868e609a96",
+  "metadata": {
+    "participants": [
+      "did:ethr:0x54b75d2a0925508682e65194cccb6f1e8eaafb2c" // DID of transaction participants
+    ],
+    "nodeUrl": "https://api-qa.eu.notabene.dev",
+    "transactionType": "withdraw"
+  },
+  "status": "completed",
+  "result": { // the response returned from the embedded component when all information is successfully collected
+    "proof": {
+      //...
+    },
+    "txCreate": {
+      //...
+    },
+    "errors": [],
+    "status": "pending",
+    "valid": true,
+    "value": {
+      //...
+    },
+    "ivms101": {
+      //...
+    }
+  }
+}
+
+```
+
+Once the host has retrieved the completed data, they can finalize the transaction by submitting it to the Notabene API.
+
 ## Error handling
 
 If any error occurs, the `error` event is passed containing a message.
@@ -484,7 +658,6 @@ The `asset` field the following types of assets specified:
 
 - `notabene_asset` code passed as a`string`. See [Notabene Assets Service](https://devx.notabene.id/docs/coins-decimals#assets-service-api).
 - [CAIP-19](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md_) is a chain agnostic format allows you to support the widest amount of assets and blockchains including NFTs.
-- [DTI](https://www.iso.org/standard/80601.html) is the ISO Digital Token Identifier format. See [DTI registry](https://dtif.org/registry-search/) for supported tokens.
 
 ### Transaction amount
 
@@ -501,18 +674,9 @@ Specify the beneficiary address as `destination` using one of the following form
 - [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
 - Native blockchain address
 
-### Origin
-
-Specify the originator address as `origin` using one of the following formats:
-
-- [CAIP-10](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md_) is a chain agnostic format allows you to specify the specific blockchain and address
-- [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
-- [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
-- Native blockchain address
-
 ### Source
 
-Specify the source address as `source` using one of the following formats:
+Specify the originator address as `source` using one of the following formats:
 
 - [CAIP-10](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md_) is a chain agnostic format allows you to specify the specific blockchain and address
 - [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
@@ -546,6 +710,7 @@ import Notabene, {
 } from '@notabene/javascript-sdk';
 
 const options: TransactionOptions = {
+  jurisdiction: "US", // Defaults to the jurisdiction associated with customer token
   proofs: {
     reuseProof: true, // Defaults true
     microTransfer: {
@@ -588,16 +753,23 @@ const options: TransactionOptions = {
       nationalIdentification: false,
       countryOfRegistration: true,
     },
-    vasps: {
-      addUnknown: true, // Allow users to add a missing VASP - Defaults to false
-      onlyActive: true, // Only list active VASPs - Default false
-      searchable: [
-        VASPSearchControl.ALLOWED, // JS: 'allowed'
-        VASPSearchControl.PENDING, // JS: 'pending'
-      ], // Control searches for VASPs - Defaults to undefined
-    },
     hide: [ValidationSections.ASSET, ValidationSections.DESTINATION], // Don't show specific sections of component
   },
+  vasps: {
+    addUnknown: true, // Allow users to add a missing VASP - Defaults to false
+    onlyActive: true, // Only list active VASPs - Default false
+    searchable: [
+      VASPSearchControl.ALLOWED, // JS: 'allowed'
+      VASPSearchControl.PENDING, // JS: 'pending'
+    ], // Control searches for VASPs - Defaults to undefined
+  },
+  counterpartyAssist: { // Allows users to share a link to collect counterparty data
+    counterpartyTypes: [
+      PersonType.LEGAL, // JS: 'legal'
+      PersonType.NATURAL, // JS: 'natural'
+      PersonType.SELF, // JS: 'self'
+    ],
+  }
 };
 const withdrawal = notabene.createWithdrawalAssist(tx, options);
 ```
@@ -739,9 +911,13 @@ The two options are:
 
 ### Counterparty Field Properties
 
-The fields requested from a customer about a counterparty can be configured with the fields object. You can configure required and optional fields individually for both natural and legal persons.
+By default, counterparty fields are determined based on the rules of the jurisdiction associated with the VASP using the component. This ensures compliance even when fields are not explicitly configured.
+
+If a specific jurisdiction is manually configured, the component will instead derive the fields according to that jurisdiction’s rules.
 
-We recommend working closely with your compliance team for this. Bearing in mind that different jurisdictions have different rules.
+For VASPs seeking more granular control over the fields displayed to customers about counterparties, the fields object can be used to customize visibility. Required and optional fields can be configured independently for both natural and legal persons.
+
+We recommend working closely with your compliance team when making these configurations, as regulatory requirements vary significantly across jurisdictions.
 
 Each field can be configured like this:
 
@@ -787,8 +963,8 @@ const options: TransactionOptions = {
     },
     legalPerson: {
       name: true, // Default true
-      lei: true, // Default true
-      website: { optional: true }, // Default true
+      lei: {optional: true }, // Default optional
+      website: { optional: true }, // Default optional
       email: true,
       phone: true,
       geographicAddress: false,

package/docs/_media/TransactionOptions.md

@@ -16,7 +16,7 @@ Configuration options for Transaction components
 
 #### Defined in
 
-[types.ts:844](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L844)
+[types.ts:854](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L854)
 
 ***
 
@@ -26,17 +26,17 @@ Configuration options for Transaction components
 
 #### Defined in
 
-[types.ts:845](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L845)
+[types.ts:855](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L855)
 
 ***
 
-### counterpartyAssistConfig?
+### counterpartyAssist?
 
-> `optional` **counterpartyAssistConfig**: [`CounterpartyAssistConfig`](../type-aliases/CounterpartyAssistConfig.md)
+> `optional` **counterpartyAssist**: [`CounterpartyAssistConfig`](../type-aliases/CounterpartyAssistConfig.md)
 
 #### Defined in
 
-[types.ts:849](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L849)
+[types.ts:859](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L859)
 
 ***
 
@@ -46,7 +46,7 @@ Configuration options for Transaction components
 
 #### Defined in
 
-[types.ts:846](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L846)
+[types.ts:856](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L856)
 
 ***
 
@@ -56,7 +56,17 @@ Configuration options for Transaction components
 
 #### Defined in
 
-[types.ts:848](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L848)
+[types.ts:858](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L858)
+
+***
+
+### jurisdiction?
+
+> `optional` **jurisdiction**: `string`
+
+#### Defined in
+
+[types.ts:853](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L853)
 
 ***
 
@@ -94,7 +104,7 @@ Configuration options for Transaction components
 
 #### Defined in
 
-[types.ts:834](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L834)
+[types.ts:843](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L843)
 
 ***
 
@@ -104,4 +114,4 @@ Configuration options for Transaction components
 
 #### Defined in
 
-[types.ts:847](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/types.ts#L847)
+[types.ts:857](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/types.ts#L857)

package/docs/_media/getRefreshResult.md

@@ -0,0 +1,35 @@
+[**@notabene/javascript-sdk**](../../README.md)
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / getRefreshResult
+
+# Function: getRefreshResult()
+
+> **getRefreshResult**\<`T`\>(`refreshSource`): `Promise`\<[`ConnectionResult`](../type-aliases/ConnectionResult.md)\<`T`\>\>
+
+Retrieves and processes connection refresh data
+
+## Type Parameters
+
+• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
+
+Type of component request
+
+## Parameters
+
+### refreshSource
+
+[`RefreshSource`](../../types/interfaces/RefreshSource.md)
+
+Source information for the refresh operation
+
+## Returns
+
+`Promise`\<[`ConnectionResult`](../type-aliases/ConnectionResult.md)\<`T`\>\>
+
+Promise resolving to connection result with decrypted data
+
+## Defined in
+
+[utils/connections.ts:60](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/utils/connections.ts#L60)

package/docs/ivms/types/enumerations/PayloadVersionCode.md

@@ -18,7 +18,7 @@ Published May 2020
 
 #### Defined in
 
-[ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L365)
+[ivms/types.ts:365](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/ivms/types.ts#L365)
 
 ***
 
@@ -30,4 +30,4 @@ Published August 2023
 
 #### Defined in
 
-[ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L367)
+[ivms/types.ts:367](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/ivms/types.ts#L367)

package/docs/ivms/types/interfaces/PayloadMetadata.md

@@ -19,7 +19,7 @@ The version of IVMS 101 to which the payload complies.
 
 #### Defined in
 
-[ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L358)
+[ivms/types.ts:358](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/ivms/types.ts#L358)
 
 ***
 
@@ -31,4 +31,4 @@ The method used to map from a national system of writing to Latin script.
 
 #### Defined in
 
-[ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L356)
+[ivms/types.ts:356](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/ivms/types.ts#L356)

package/docs/ivms/types/type-aliases/Address.md

@@ -111,4 +111,4 @@ Name of a built-up area, with defined boundaries, and a local government.
 
 ## Defined in
 
-[ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/ivms/types.ts#L119)
+[ivms/types.ts:119](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/52abba74a4a6b14d6ca0d23191964d38919d32ea/src/ivms/types.ts#L119)