Addresses
Get all addresses
Returns all addresses associated with the specified accounts within the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/addresses/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token. |
| array of string | optional, max 1000 items | |
| array of string | optional, max 1000 items | Unique identifiers of Addresses within the enterprise. Use this property if you want to fetch specific addresses. Required if no other filter is provided. |
| optional, max length 3 months | Interval of Address last update date and time. Required if no other filter is provided. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account address | required | The collection of Account addresses, containing address and account information. |
| string | required | Unique identifier of the last and hence oldest address item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older Account address. |
Account address
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the address. |
| string | optional | Unique identifier of the chain. |
| string | required | |
| string | required | A discriminator specifying the type of account, e.g. customer or company. |
| string | optional | First line of the address. |
| string | optional | Second line of the address. |
| string | optional | The city. |
| string | optional | Postal code. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | ISO 3166-2 code of the administrative division, e.g. |
| number | optional | The latitude. |
| number | optional | The longitude. |
| string | optional | Last update date and time of the address in UTC timezone in ISO 8601 format. |
| boolean | required | Whether the address is still active. |
Add addresses
Adds one or more new addresses to the system and assigns them to specified accounts. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/addresses/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Account address parameters, max 1000 items | required | Collection of addresses to be created. |
Account address parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | |
| string | optional | First line of the address. |
| string | optional | Second line of the address. |
| string | optional | The city. |
| string | optional | Postal code. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | ISO 3166-2 code of the administrative division, e.g. |
| number | optional | The latitude in range of -90 to 90. |
| number | optional | The longitude in range of -180 to 180. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account address | required | Created addresses. |
Update addresses
Updates one or more existing addresses in the system, assigned to specified accounts. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/addresses/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Account address updates, max 1000 items | required | Collection of addresses to be updated. |
Account address update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the address. |
| string | required | |
| optional | First line of the address. | |
| optional | Second line of the address. | |
| optional | The city. | |
| optional | Postal code. | |
| optional | ISO 3166-1 code of the Country. | |
| optional | ISO 3166-2 code of the administrative division, e.g. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account address | required | Updated addresses. |
Delete addresses
Deletes one or more addresses in the system. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/addresses/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of string | required, max 1000 items | Unique identifiers of Addresses within the enterprise to be deleted. |
Response
Last updated