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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainIds": [
    "1df21f06-0cfc-4960-9c58-a3bf1261663e",
    "5fcd1933-22f2-40b9-84da-7db04cbecec2"
  ],
  "AccountIds": [
    "3db2c989-7d95-42b4-a502-a9f246db1634"
  ],
  "AddressIds": [
    "fc7b2df3-de66-48a6-907d-af4600ecd892"
  ],
  "UpdatedUtc": {
    "StartUtc": "2022-12-10T00:00:00Z",
    "EndUtc": "2022-12-17T00:00:00Z"
  },
  "ActivityStates": [
    "Active"
  ],
  "Limitation": {
    "Count": 10
  }
}
Property
Type
Contract
Description

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": [
    {
      "Id": "fc7b2df3-de66-48a6-907d-af4600ecd892",
      "AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
      "AccountType": "Customer",
      "Line1": "I.P. Pavlova 5",
      "Line2": null,
      "City": "Prague",
      "PostalCode": "12000",
      "CountryCode": "CZ",
      "CountrySubdivisionCode": null,
      "Latitude": null,
      "Longitude": null,
      "UpdatedUtc": "2023-11-29T14:49:29.982Z",
      "IsActive": true
    }
  ]
}
Property
Type
Contract
Description

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

Property
Type
Contract
Description

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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
  "Addresses": [
    {
      "AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
      "Line1": "Rheinlanddamm 207-209",
      "Line2": null,
      "City": "Dortmund",
      "PostalCode": "44137",
      "CountryCode": "DE",
      "CountrySubdivisionCode": null,
      "Latitude": null,
      "Longitude": null
    }
  ]
}
Property
Type
Contract
Description

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

Property
Type
Contract
Description

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": [
    {
      "Id": "fc7b2df3-de66-48a6-907d-af4600ecd892",
      "AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
      "AccountType": "Customer",
      "Line1": "I.P. Pavlova 5",
      "Line2": null,
      "City": "Prague",
      "PostalCode": "12000",
      "CountryCode": "CZ",
      "CountrySubdivisionCode": null,
      "Latitude": null,
      "Longitude": null,
      "UpdatedUtc": "2023-11-29T14:49:29.982Z",
      "IsActive": true
    }
  ]
}
Property
Type
Contract
Description

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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
  "AddressUpdates": [
    {
      "AddressId": "fc7b2df3-de66-48a6-907d-af4600ecd892",
      "AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
      "Line1": {
        "Value": "I.P. Pavlova 5"
      },
      "Line2": {
        "Value": null
      },
      "City": {
        "Value": "Prague"
      },
      "PostalCode": {
        "Value": "12000"
      },
      "CountryCode": {
        "Value": "CZ"
      },
      "CountrySubdivisionCode": {
        "Value": null
      }
    }
  ]
}
Property
Type
Contract
Description

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

Property
Type
Contract
Description

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": [
    {
      "Id": "fc7b2df3-de66-48a6-907d-af4600ecd892",
      "AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634",
      "AccountType": "Customer",
      "Line1": "I.P. Pavlova 5",
      "Line2": null,
      "City": "Prague",
      "PostalCode": "12000",
      "CountryCode": "CZ",
      "CountrySubdivisionCode": null,
      "Latitude": null,
      "Longitude": null,
      "UpdatedUtc": "2023-11-29T14:49:29.982Z",
      "IsActive": true
    }
  ]
}
Property
Type
Contract
Description

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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
  "AddressIds": [
    "cefa640f-43fa-4a02-8d20-f97f68e19ed5",
    "44108366-8e9b-4007-844b-8ebcca4ac009"
  ]
}
Property
Type
Contract
Description

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