@notabene/javascript-sdk 2.0.1 → 2.0.3

package/docs/types/interfaces/LegalPerson.md

@@ -0,0 +1,202 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / LegalPerson
+
+# Interface: LegalPerson
+
+Interface representing a legal entity (organization/company) involved in a transaction
+
+## Remarks
+
+Extends the baseface to add properties specific to legal entities:
+- type: MustPersonType.LEGAL to identify as an organization
+- name: Required registered legal name of the entity
+- lei: Optional Legal Entity Identifier for regulated entities
+- logo: Optional URI to the organization's logo image
+- countryOfRegistration: Optional ISO country code where entity is registered
+
+This interface captures the additional identifying information required for
+legal persons under FATF Travel Rule requirements. The properties align with
+standard business KYC (Know Your Businessta collection practices.
+
+## See
+
+ - [Counterparty](Counterparty.md) For base properties common to all counterparties
+ - [PersonType](../enumerations/PersonType.md) For person type classification
+ - [LEI](../type-aliases/LEI.md) For Legal Entity Identifier format
+
+## Extends
+
+- [`Counterparty`](Counterparty.md)
+
+## Properties
+
+### accountNumber?
+
+> `optional` **accountNumber**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`accountNumber`](Counterparty.md#accountnumber)
+
+#### Defined in
+
+[types.ts:341](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L341)
+
+***
+
+### countryOfRegistration?
+
+> `optional` **countryOfRegistration**: `string`
+
+#### Defined in
+
+[types.ts:426](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L426)
+
+***
+
+### did?
+
+> `optional` **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`did`](Counterparty.md#did)
+
+#### Defined in
+
+[types.ts:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L342)
+
+***
+
+### email?
+
+> `optional` **email**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`email`](Counterparty.md#email)
+
+#### Defined in
+
+[types.ts:349](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L349)
+
+***
+
+### geographicAddress?
+
+> `optional` **geographicAddress**: [`Address`](../../ivms/types/type-aliases/Address.md)
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`geographicAddress`](Counterparty.md#geographicaddress)
+
+#### Defined in
+
+[types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L345)
+
+***
+
+### lei?
+
+> `optional` **lei**: `string`
+
+#### Defined in
+
+[types.ts:424](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L424)
+
+***
+
+### logo?
+
+> `optional` **logo**: `string`
+
+#### Defined in
+
+[types.ts:425](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L425)
+
+***
+
+### name
+
+> **name**: `string`
+
+#### Overrides
+
+[`Counterparty`](Counterparty.md).[`name`](Counterparty.md#name)
+
+#### Defined in
+
+[types.ts:423](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L423)
+
+***
+
+### nationalIdentification?
+
+> `optional` **nationalIdentification**: [`NationalIdentification`](../../ivms/types/type-aliases/NationalIdentification.md)
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`nationalIdentification`](Counterparty.md#nationalidentification)
+
+#### Defined in
+
+[types.ts:346](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L346)
+
+***
+
+### phone?
+
+> `optional` **phone**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`phone`](Counterparty.md#phone)
+
+#### Defined in
+
+[types.ts:348](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L348)
+
+***
+
+### type
+
+> **type**: [`LEGAL`](../enumerations/PersonType.md#legal)
+
+#### Overrides
+
+[`Counterparty`](Counterparty.md).[`type`](Counterparty.md#type)
+
+#### Defined in
+
+[types.ts:422](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L422)
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`verified`](Counterparty.md#verified)
+
+#### Defined in
+
+[types.ts:344](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L344)
+
+***
+
+### website?
+
+> `optional` **website**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`website`](Counterparty.md#website)
+
+#### Defined in
+
+[types.ts:347](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L347)

package/docs/types/interfaces/MicroTransferProof.md

@@ -0,0 +1,119 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / MicroTransferProof
+
+# Interface: MicroTransferProof
+
+Ownership Proof using Micro Transfer
+
+## Extends
+
+- [`OwnershipProof`](OwnershipProof.md)
+
+## Properties
+
+### address
+
+> **address**: \`$\{string\}:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`address`](OwnershipProof.md#address)
+
+#### Defined in
+
+[types.ts:1019](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1019)
+
+***
+
+### amountSubunits
+
+> **amountSubunits**: `string`
+
+#### Defined in
+
+[types.ts:1095](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1095)
+
+***
+
+### asset
+
+> **asset**: \`$\{string\}:$\{string\}/$\{string\}:$\{string\}\`
+
+#### Defined in
+
+[types.ts:1093](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1093)
+
+***
+
+### chain
+
+> **chain**: \`$\{string\}:$\{string\}\`
+
+#### Defined in
+
+[types.ts:1092](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1092)
+
+***
+
+### destination
+
+> **destination**: `string`
+
+#### Defined in
+
+[types.ts:1094](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1094)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`did`](OwnershipProof.md#did)
+
+#### Defined in
+
+[types.ts:1018](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1018)
+
+***
+
+### proof
+
+> **proof**: `string`
+
+#### Defined in
+
+[types.ts:1091](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1091)
+
+***
+
+### status
+
+> **status**: [`ProofStatus`](../enumerations/ProofStatus.md)
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`status`](OwnershipProof.md#status)
+
+#### Defined in
+
+[types.ts:1017](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1017)
+
+***
+
+### type
+
+> **type**: [`MicroTransfer`](../enumerations/ProofTypes.md#microtransfer)
+
+#### Overrides
+
+[`OwnershipProof`](OwnershipProof.md).[`type`](OwnershipProof.md#type)
+
+#### Defined in
+
+[types.ts:1090](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1090)

package/docs/types/interfaces/NaturalPerson.md

@@ -0,0 +1,201 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / NaturalPerson
+
+# Interface: NaturalPerson
+
+Interface representing a natural person (individual) involved in a transaction
+
+## Remarks
+
+Extends the baseinterface to add properties specific to individual persons:
+- type: Must be PersonType.NATURAL to identify as an individual
+- dateOfBirth: Optional ISO format birth date for identity verification
+- placeOfBirth: Optional birth place for identity verification
+- countryOfResidence: Optional ISO country code of current residence
+- name: Required full legal name of the individual
+
+This interface captures the additional identifying information required for
+natural persons under FATF Travel Rule requirements. The properties align
+with standard KYC (Know Your Customer) data collection practices.
+
+## See
+
+ - [Counterparty](Counterparty.md) For base properties common to all counterparties
+ - [PersonType](../enumerations/PersonType.md) For person type classification
+
+## Extends
+
+- [`Counterparty`](Counterparty.md)
+
+## Properties
+
+### accountNumber?
+
+> `optional` **accountNumber**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`accountNumber`](Counterparty.md#accountnumber)
+
+#### Defined in
+
+[types.ts:341](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L341)
+
+***
+
+### countryOfResidence?
+
+> `optional` **countryOfResidence**: `string`
+
+#### Defined in
+
+[types.ts:375](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L375)
+
+***
+
+### dateOfBirth?
+
+> `optional` **dateOfBirth**: \`$\{number\}-$\{number\}-$\{number\}\`
+
+#### Defined in
+
+[types.ts:373](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L373)
+
+***
+
+### did?
+
+> `optional` **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`did`](Counterparty.md#did)
+
+#### Defined in
+
+[types.ts:342](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L342)
+
+***
+
+### email?
+
+> `optional` **email**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`email`](Counterparty.md#email)
+
+#### Defined in
+
+[types.ts:349](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L349)
+
+***
+
+### geographicAddress?
+
+> `optional` **geographicAddress**: [`Address`](../../ivms/types/type-aliases/Address.md)
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`geographicAddress`](Counterparty.md#geographicaddress)
+
+#### Defined in
+
+[types.ts:345](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L345)
+
+***
+
+### name
+
+> **name**: `string`
+
+#### Overrides
+
+[`Counterparty`](Counterparty.md).[`name`](Counterparty.md#name)
+
+#### Defined in
+
+[types.ts:376](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L376)
+
+***
+
+### nationalIdentification?
+
+> `optional` **nationalIdentification**: [`NationalIdentification`](../../ivms/types/type-aliases/NationalIdentification.md)
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`nationalIdentification`](Counterparty.md#nationalidentification)
+
+#### Defined in
+
+[types.ts:346](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L346)
+
+***
+
+### phone?
+
+> `optional` **phone**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`phone`](Counterparty.md#phone)
+
+#### Defined in
+
+[types.ts:348](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L348)
+
+***
+
+### placeOfBirth?
+
+> `optional` **placeOfBirth**: `string`
+
+#### Defined in
+
+[types.ts:374](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L374)
+
+***
+
+### type
+
+> **type**: [`NATURAL`](../enumerations/PersonType.md#natural)
+
+#### Overrides
+
+[`Counterparty`](Counterparty.md).[`type`](Counterparty.md#type)
+
+#### Defined in
+
+[types.ts:372](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L372)
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`verified`](Counterparty.md#verified)
+
+#### Defined in
+
+[types.ts:344](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L344)
+
+***
+
+### website?
+
+> `optional` **website**: `string`
+
+#### Inherited from
+
+[`Counterparty`](Counterparty.md).[`website`](Counterparty.md#website)
+
+#### Defined in
+
+[types.ts:347](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L347)

package/docs/types/interfaces/OwnershipProof.md

@@ -0,0 +1,77 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / OwnershipProof
+
+# Interface: OwnershipProof
+
+Base interface for proving ownership of an account or address
+
+## Remarks
+
+TheOwnershipProof interface provides a common structure for different types of ownership verification:
+- All proofs must specify their type from the supported ProofTypes enum
+- Current verification status is tracked via ProofStatus
+- Links the proof to a decentralized identifier (DID)
+- Specifies the blockchain account/address being proven using CAIP-10 format
+
+This interface is extended by specific proof types like:
+- SignatureProof for cryptographic signatures
+- DeclarationProof for self-declarations
+- MicroTransferProof for transaction-based proof
+- ScreenshotProof for image-based verification
+
+## See
+
+ - [ProofTypes](../enumerations/ProofTypes.md) For supported proof methods
+ - [ProofStatus](../enumerations/ProofStatus.md) For possible verification states
+ - [CAIP10](../type-aliases/CAIP10.md) For address format specification
+
+## Extended by
+
+- [`SignatureProof`](SignatureProof.md)
+- [`DeclarationProof`](DeclarationProof.md)
+- [`ConnectionRecord`](ConnectionRecord.md)
+- [`MicroTransferProof`](MicroTransferProof.md)
+- [`ScreenshotProof`](ScreenshotProof.md)
+
+## Properties
+
+### address
+
+> **address**: \`$\{string\}:$\{string\}:$\{string\}\`
+
+#### Defined in
+
+[types.ts:1019](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1019)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Defined in
+
+[types.ts:1018](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1018)
+
+***
+
+### status
+
+> **status**: [`ProofStatus`](../enumerations/ProofStatus.md)
+
+#### Defined in
+
+[types.ts:1017](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1017)
+
+***
+
+### type
+
+> **type**: [`ProofTypes`](../enumerations/ProofTypes.md)
+
+#### Defined in
+
+[types.ts:1016](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1016)

package/docs/types/interfaces/ScreenshotProof.md

@@ -0,0 +1,79 @@
+[**@notabene/javascript-sdk**](../../README.md) • **Docs**
+
+***
+
+[@notabene/javascript-sdk](../../modules.md) / [types](../README.md) / ScreenshotProof
+
+# Interface: ScreenshotProof
+
+Ownership Proof using Screenshot
+
+## Extends
+
+- [`OwnershipProof`](OwnershipProof.md)
+
+## Properties
+
+### address
+
+> **address**: \`$\{string\}:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`address`](OwnershipProof.md#address)
+
+#### Defined in
+
+[types.ts:1019](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1019)
+
+***
+
+### did
+
+> **did**: \`did:$\{string\}:$\{string\}\`
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`did`](OwnershipProof.md#did)
+
+#### Defined in
+
+[types.ts:1018](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1018)
+
+***
+
+### status
+
+> **status**: [`ProofStatus`](../enumerations/ProofStatus.md)
+
+#### Inherited from
+
+[`OwnershipProof`](OwnershipProof.md).[`status`](OwnershipProof.md#status)
+
+#### Defined in
+
+[types.ts:1017](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1017)
+
+***
+
+### type
+
+> **type**: [`Screenshot`](../enumerations/ProofTypes.md#screenshot)
+
+#### Overrides
+
+[`OwnershipProof`](OwnershipProof.md).[`type`](OwnershipProof.md#type)
+
+#### Defined in
+
+[types.ts:1103](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1103)
+
+***
+
+### url
+
+> **url**: `string`
+
+#### Defined in
+
+[types.ts:1104](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/675e0bac9f2136d1cf47e6f5980760f80d3d1995/src/types.ts#L1104)