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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of Chain
. If not specified, the operation returns data for all chains within scope of the Access Token.
AccountIds
array of string
optional, max 1000 items
AddressIds
array of string
optional, max 1000 items
UpdatedUtc
optional, max length 3 months
Interval of Address last update date and time. Required if no other filter is provided.
ActivityStates
optional
Whether to return only active, only deleted or both records.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Response
Addresses
required
The collection of Account addresses, containing address and account information.
Cursor
string
optional
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
Id
string
required
Unique identifier of the address.
AccountId
string
required
ChainId
string
optional
Unique identifier of the chain.
AccountType
required
Line1
string
optional, max length 1023 characters
First line of the address.
Line2
string
optional, max length 255 characters
Second line of the address.
City
string
optional, max length 255 characters
The city.
PostalCode
string
optional, max length 255 characters
Postal code.
CountryCode
string
optional
ISO 3166-1 alpha-2 code of the Country.
CountrySubdivisionCode
string
optional
ISO 3166-2 code of the administrative division, e.g. DE-BW.
Latitude
number
optional
The latitude.
Longitude
number
optional
The longitude.
UpdatedUtc
string
optional
Last update date and time of the address in UTC timezone in ISO 8601 format.
IsActive
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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
Addresses
required, max 1000 items
Collection of addresses to be created.
Account address parameters
AccountId
string
required
Unique identifier of a Company or a Customer within the enterprise.
Line1
string
optional, max length 255 characters
First line of the address.
Line2
string
optional, max length 255 characters
Second line of the address.
City
string
optional, max length 255 characters
The city.
PostalCode
string
optional, max length 255 characters
Postal code.
CountryCode
string
optional
ISO 3166-1 alpha-2 code of the Country.
CountrySubdivisionCode
string
optional
ISO 3166-2 code of the administrative division, e.g. DE-BW
.
Latitude
number
optional
The latitude in range of -90 to 90.
Longitude
number
optional
The longitude in range of -180 to 180.
Response
Addresses
required
The collection of added or modified Account addresses, containing address and account information.
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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
AddressUpdates
required, max 1000 items
Collection of addresses to be updated.
Account address update parameters
AddressId
string
required
Unique identifier of the address.
Line1
optional, max length 255 characters
First line of the address.
Line2
optional, max length 255 characters
Second line of the address.
City
optional, max length 255 characters
The city.
PostalCode
optional, max length 255 characters
Postal code.
CountryCode
optional
ISO 3166-1 alpha-2 code of the Country.
CountrySubdivisionCode
optional
ISO 3166-2 code of the administrative division, e.g. DE-BW
.
Response
Addresses
required
The collection of added or modified Account addresses, containing address and account information.
Delete addresses
Deletes one or more addresses in the system. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/addresses/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
AddressIds
array of string
required, max 1000 items
Response
Last updated