# UnboundCaspApi.VaultsApi

All URIs are relative to *https://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**addVaultCoin**](VaultsApi.md#addVaultCoin) | **POST** /casp/api/v1.0/mng/vaults/{id}/coins | Add a coin type to a BIP44 vault
[**addVaultMember**](VaultsApi.md#addVaultMember) | **POST** /casp/api/v1.0/mng/vaults/{id}/members | Add participant to an existing quorum vault group
[**createAccount**](VaultsApi.md#createAccount) | **POST** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts | Add a BIP44 account to a coin in an BIP44 vault
[**createDerivedKey**](VaultsApi.md#createDerivedKey) | **POST** /casp/api/v1.0/mng/vaults/{vaultId}/derivations | Derive a key in an BIP32 vault
[**createPublicKey**](VaultsApi.md#createPublicKey) | **POST** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts/{accountIndex}/chains/{chain}/addresses | Create a new BIP44 address
[**createSignOperation**](VaultsApi.md#createSignOperation) | **POST** /casp/api/v1.0/mng/vaults/{id}/sign | Start a vault signing process
[**createVault**](VaultsApi.md#createVault) | **POST** /casp/api/v1.0/mng/accounts/{id}/vaults | Create new quorum vault
[**findVaultAccount**](VaultsApi.md#findVaultAccount) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts/find | Find account index by name
[**getBackup**](VaultsApi.md#getBackup) | **GET** /casp/api/v1.0/mng/vaults/{id}/backup | Get quorum vault backup data
[**getDerivedKey**](VaultsApi.md#getDerivedKey) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/derivation | Get public key by derivation path
[**getPublicKey**](VaultsApi.md#getPublicKey) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/publickey | Returns a deterministic vault's public key
[**getPublicKeyBackup**](VaultsApi.md#getPublicKeyBackup) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/backup/{publicKey} | Get backup data for public key
[**getSeed**](VaultsApi.md#getSeed) | **GET** /casp/api/v1.0/mng/vaults/{id}/seed | Get the encrypted seed of a quorum vault
[**getSignOperation**](VaultsApi.md#getSignOperation) | **GET** /casp/api/v1.0/mng/operations/sign/{operationid} | Get sign metadata
[**getVault**](VaultsApi.md#getVault) | **GET** /casp/api/v1.0/mng/vaults/{id} | Get vault info
[**getVaultAccount**](VaultsApi.md#getVaultAccount) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts/{accountIdentifier} | List all the addresses in a BIP44 vault for a given coin type and account index
[**getVaultAccountBackup**](VaultsApi.md#getVaultAccountBackup) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts/{accountIdentifier}/backup | Get BIP44 account backup for account
[**listAccounts**](VaultsApi.md#listAccounts) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts | List all the accounts in a BIP44 vault for a given coin
[**listAllKeysInAnBIP32Vault**](VaultsApi.md#listAllKeysInAnBIP32Vault) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/derivations | listDerivedKeys
[**listCoins**](VaultsApi.md#listCoins) | **GET** /casp/api/v1.0/mng/vaults/{id}/coins | List all the coins in a BIP44 vault
[**listOperationsPerVaultAccount**](VaultsApi.md#listOperationsPerVaultAccount) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts/{accountIdentifier}/operations | List sub account operations
[**listPublicKeys**](VaultsApi.md#listPublicKeys) | **GET** /casp/api/v1.0/mng/vaults/{vaultId}/coins/{coinType}/accounts/{accountIndex}/chains/{chain}/addresses | List all the public keys for addresses in a BIP44 vault for a given coin type, account index and address chain type
[**listVaults**](VaultsApi.md#listVaults) | **GET** /casp/api/v1.0/mng/accounts/{id}/vaults | List vaults per account
[**updateVaultMember**](VaultsApi.md#updateVaultMember) | **PUT** /casp/api/v1.0/mng/vaults/{id}/members/{participantid} | Deactivate a participant for a specific quorum vault


<a name="addVaultCoin"></a>
# **addVaultCoin**
> addVaultCoin(id, body)

Add a coin type to a BIP44 vault



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | Vault ID

var body = new UnboundCaspApi.Body7(); // Body7 | Add vault group member request

apiInstance.addVaultCoin(id, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Vault ID | 
 **body** | [**Body7**](Body7.md)| Add vault group member request | 

### Return type

null (empty response body)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="addVaultMember"></a>
# **addVaultMember**
> InlineResponse20013 addVaultMember(id, body)

Add participant to an existing quorum vault group

This API is used if a participant becomes unavailable or leaves an account and needs to be replaced with a new participant. A new participant may be added to an existing vault, but requires the approval of the existing vault quorum.

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | Vault ID

var body = new UnboundCaspApi.Body8(); // Body8 | Add vault group member request

apiInstance.addVaultMember(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Vault ID | 
 **body** | [**Body8**](Body8.md)| Add vault group member request | 

### Return type

[**InlineResponse20013**](InlineResponse20013.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createAccount"></a>
# **createAccount**
> InlineResponse20016 createAccount(vaultId, coinType, opts)

Add a BIP44 account to a coin in an BIP44 vault



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var opts = { 
  'body': new UnboundCaspApi.Body11() // Body11 | Add BIP44 account request
};
apiInstance.createAccount(vaultId, coinType, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **body** | [**Body11**](Body11.md)| Add BIP44 account request | [optional] 

### Return type

[**InlineResponse20016**](InlineResponse20016.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createDerivedKey"></a>
# **createDerivedKey**
> InlineResponse20020 createDerivedKey(vaultId, opts)

Derive a key in an BIP32 vault



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var opts = { 
  'body': new UnboundCaspApi.Body12() // Body12 | Derive a keypair in an BIP32 vault
};
apiInstance.createDerivedKey(vaultId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **body** | [**Body12**](Body12.md)| Derive a keypair in an BIP32 vault | [optional] 

### Return type

[**InlineResponse20020**](InlineResponse20020.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createPublicKey"></a>
# **createPublicKey**
> InlineResponse20019 createPublicKey(vaultId, coinType, accountIndex, chain)

Create a new BIP44 address



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var accountIndex = 56; // Number | BIP44 account index

var chain = "chain_example"; // String | Add vault group member request

apiInstance.createPublicKey(vaultId, coinType, accountIndex, chain).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **accountIndex** | **Number**| BIP44 account index | 
 **chain** | **String**| Add vault group member request | 

### Return type

[**InlineResponse20019**](InlineResponse20019.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="createSignOperation"></a>
# **createSignOperation**
> InlineResponse20013 createSignOperation(id, body)

Start a vault signing process

Starts the process of a signing operation.  - For a quorum vault, the operation finishes when the minimum number of participants approve the transaction signing operation.   You can check the task status by calling the **_/operations** API. When the signature is ready it is provided in the response payload.   This service should be used when the blockchain management is done outside of CASP, as it only signs the transaction without sending it to the relevant blockchain.

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | QuorumVault ID

var body = new UnboundCaspApi.Body10(); // Body10 | Sign Request

apiInstance.createSignOperation(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| QuorumVault ID | 
 **body** | [**Body10**](Body10.md)| Sign Request | 

### Return type

[**InlineResponse20013**](InlineResponse20013.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createVault"></a>
# **createVault**
> InlineResponse2012 createVault(id, body)

Create new quorum vault

This request starts the process of creating a new quorum vault. The vault is created only after the participants approve the vault creation according to the vault policy.

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | Account ID

var body = new UnboundCaspApi.Body3(); // Body3 | Create QuorumVault Request

apiInstance.createVault(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Account ID | 
 **body** | [**Body3**](Body3.md)| Create QuorumVault Request | 

### Return type

[**InlineResponse2012**](InlineResponse2012.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="findVaultAccount"></a>
# **findVaultAccount**
> InlineResponse20017 findVaultAccount(vaultId, coinType, accountName)

Find account index by name



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var accountName = "accountName_example"; // String | BIP44 account name

apiInstance.findVaultAccount(vaultId, coinType, accountName).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **accountName** | **String**| BIP44 account name | 

### Return type

[**InlineResponse20017**](InlineResponse20017.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getBackup"></a>
# **getBackup**
> InlineResponse20011 getBackup(id)

Get quorum vault backup data

The vault cryptographic material is backed up with a key that is external to the CASP system. The backup can be used for safe recovery of the vault in case of service failure, participants loosing their shares, or termination of CASP usage.

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | QuorumVault ID

apiInstance.getBackup(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| QuorumVault ID | 

### Return type

[**InlineResponse20011**](InlineResponse20011.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getDerivedKey"></a>
# **getDerivedKey**
> InlineResponse20020 getDerivedKey(vaultId, derivationPath)

Get public key by derivation path



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var derivationPath = "derivationPath_example"; // String | Derivation path

apiInstance.getDerivedKey(vaultId, derivationPath).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **derivationPath** | **String**| Derivation path | 

### Return type

[**InlineResponse20020**](InlineResponse20020.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getPublicKey"></a>
# **getPublicKey**
> InlineResponse20021 getPublicKey(vaultId)

Returns a deterministic vault&#39;s public key



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

apiInstance.getPublicKey(vaultId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 

### Return type

[**InlineResponse20021**](InlineResponse20021.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getPublicKeyBackup"></a>
# **getPublicKeyBackup**
> InlineResponse20011 getPublicKeyBackup(vaultId, publicKey)

Get backup data for public key

The vault cryptographic material is backed up with a key that is external to the CASP system. The backup can be used for safe recovery of the vault in case of service failure, participants loosing their shares, or termination of CASP usage.

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | QuorumVault ID

var publicKey = "publicKey_example"; // String | public key

apiInstance.getPublicKeyBackup(vaultId, publicKey).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| QuorumVault ID | 
 **publicKey** | **String**| public key | 

### Return type

[**InlineResponse20011**](InlineResponse20011.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getSeed"></a>
# **getSeed**
> InlineResponse20014 getSeed(id, wrappingKeyId)

Get the encrypted seed of a quorum vault



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | QuorumVault ID

var wrappingKeyId = "wrappingKeyId_example"; // String | The UKC ID of the key that will wrap the vault's seed

apiInstance.getSeed(id, wrappingKeyId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| QuorumVault ID | 
 **wrappingKeyId** | **String**| The UKC ID of the key that will wrap the vault&#39;s seed | 

### Return type

[**InlineResponse20014**](InlineResponse20014.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getSignOperation"></a>
# **getSignOperation**
> InlineResponse2007 getSignOperation(operationid)

Get sign metadata

Returns the sign operation metadata

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var operationid = "operationid_example"; // String | Operation ID

apiInstance.getSignOperation(operationid).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **operationid** | **String**| Operation ID | 

### Return type

[**InlineResponse2007**](InlineResponse2007.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getVault"></a>
# **getVault**
> InlineResponse20010 getVault(id)

Get vault info

Get details of a vault

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | QuorumVault ID

apiInstance.getVault(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| QuorumVault ID | 

### Return type

[**InlineResponse20010**](InlineResponse20010.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getVaultAccount"></a>
# **getVaultAccount**
> InlineResponse20016 getVaultAccount(vaultId, coinType, accountIdentifier)

List all the addresses in a BIP44 vault for a given coin type and account index



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var accountIdentifier = "accountIdentifier_example"; // String | BIP44 account identifier. the index or name

apiInstance.getVaultAccount(vaultId, coinType, accountIdentifier).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **accountIdentifier** | **String**| BIP44 account identifier. the index or name | 

### Return type

[**InlineResponse20016**](InlineResponse20016.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getVaultAccountBackup"></a>
# **getVaultAccountBackup**
> InlineResponse20018 getVaultAccountBackup(vaultId, coinType, accountIdentifier)

Get BIP44 account backup for account



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var accountIdentifier = "accountIdentifier_example"; // String | BIP44 account identifier. the index or name

apiInstance.getVaultAccountBackup(vaultId, coinType, accountIdentifier).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **accountIdentifier** | **String**| BIP44 account identifier. the index or name | 

### Return type

[**InlineResponse20018**](InlineResponse20018.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listAccounts"></a>
# **listAccounts**
> [InlineResponse20015] listAccounts(vaultId, coinType)

List all the accounts in a BIP44 vault for a given coin



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

apiInstance.listAccounts(vaultId, coinType).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 

### Return type

[**[InlineResponse20015]**](InlineResponse20015.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listAllKeysInAnBIP32Vault"></a>
# **listAllKeysInAnBIP32Vault**
> [InlineResponse20020] listAllKeysInAnBIP32Vault(vaultId)

listDerivedKeys



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

apiInstance.listAllKeysInAnBIP32Vault(vaultId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 

### Return type

[**[InlineResponse20020]**](InlineResponse20020.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listCoins"></a>
# **listCoins**
> InlineResponse20012 listCoins(id)

List all the coins in a BIP44 vault



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | Vault ID

apiInstance.listCoins(id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Vault ID | 

### Return type

[**InlineResponse20012**](InlineResponse20012.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listOperationsPerVaultAccount"></a>
# **listOperationsPerVaultAccount**
> [InlineResponse2002] listOperationsPerVaultAccount(vaultId, coinType, accountIdentifier)

List sub account operations



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var accountIdentifier = "accountIdentifier_example"; // String | BIP44 account identifier. the index or name

apiInstance.listOperationsPerVaultAccount(vaultId, coinType, accountIdentifier).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **accountIdentifier** | **String**| BIP44 account identifier. the index or name | 

### Return type

[**[InlineResponse2002]**](InlineResponse2002.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listPublicKeys"></a>
# **listPublicKeys**
> InlineResponse20016 listPublicKeys(vaultId, coinType, accountIndex, chain)

List all the public keys for addresses in a BIP44 vault for a given coin type, account index and address chain type



### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var vaultId = "vaultId_example"; // String | Vault ID

var coinType = 56; // Number | BIP44 coin type

var accountIndex = 56; // Number | BIP44 account index

var chain = "chain_example"; // String | Add vault group member request

apiInstance.listPublicKeys(vaultId, coinType, accountIndex, chain).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **vaultId** | **String**| Vault ID | 
 **coinType** | **Number**| BIP44 coin type | 
 **accountIndex** | **Number**| BIP44 account index | 
 **chain** | **String**| Add vault group member request | 

### Return type

[**InlineResponse20016**](InlineResponse20016.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listVaults"></a>
# **listVaults**
> [InlineResponse2004] listVaults(id, opts)

List vaults per account

List all vaults in the account. By default only active vaults are listed.

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var id = "id_example"; // String | Account ID

var opts = { 
  'withDeactivated': true, // Boolean | Include deactivated vaults
  'providerKind': "providerKind_example" // String | Filter by coin type
};
apiInstance.listVaults(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Account ID | 
 **withDeactivated** | **Boolean**| Include deactivated vaults | [optional] 
 **providerKind** | **String**| Filter by coin type | [optional] 

### Return type

[**[InlineResponse2004]**](InlineResponse2004.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="updateVaultMember"></a>
# **updateVaultMember**
> updateVaultMember(participantid, id, body)

Deactivate a participant for a specific quorum vault

The deactivated participant no longer takes part in the vault transaction approval processes

### Example
```javascript
var UnboundCaspApi = require('unbound_casp_api');
var defaultClient = UnboundCaspApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new UnboundCaspApi.VaultsApi();

var participantid = "participantid_example"; // String | Participant ID

var id = "id_example"; // String | vault ID

var body = new UnboundCaspApi.Body9(); // Body9 | Participant status update request

apiInstance.updateVaultMember(participantid, id, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **participantid** | **String**| Participant ID | 
 **id** | **String**| vault ID | 
 **body** | [**Body9**](Body9.md)| Participant status update request | 

### Return type

null (empty response body)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json