Constructor
new AccountHolder(options)
Creates an instance of the account holder client
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object
|
application config |
Methods
getAccountHolder() → {Promise}
Get basic information about the account holder
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
getAccountHolderBusiness() → {Promise}
Get a business account holder's details
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
getAccountHolderBusinessCorrespondenceAddress() → {Promise}
Get a business account holder's correspondence address
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
getAccountHolderBusinessRegisteredAddress() → {Promise}
Get a business account holder's registered address
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
getAccountHolderIndividual() → {Promise}
Get an individual account holder's details
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
getAccountHolderJoint() → {Promise}
Get a joint account holder's details
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
getAccountHolderName() → {Promise}
Get the name of the account holder
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise