Get Addresses

Description

Returns a list of Addresses on your account.

Request

HTTP Method: GET

URI Path: /v3/addresses

URI Query Parameters:

Name

Type

Is Required?

Description

filter[<filter_name>]

integer, string, DateTime

Optional

Filtering

includes

string

Optional

Inclusion

sort

string

Optional

Inclusion

Includes:

Value

Description

countries

Country Object

proofs

Proofs Object

proofs.proof_type

Proofs Object

identity

Identities Object

identity.country

Identities Object

identity.proofs

Identities Object

identity.proofs.proof_type

Identities Object

identity.permanent_documents

Identities Object

identity.permanent_documents.template

Identities Object

area

Area Object

city

City Object

Filters:

Filter Name

Type

Allow Blank

Allow Array

Filters by:

city_name

string

Yes

No

The city_name field.

city_name_contains

string

Yes

No

The city_name_contains field.

postal_code

string

Yes

No

The postal_code field.

postal_code_contains

string

Yes

No

The postal_code_contains field.

address

string

Yes

No

The address field.

address_contains

string

Yes

No

The address_contains field.

description

string

Yes

No

The description field.

description_contains

string

Yes

No

The description_contains field.

identity.id

string

Yes

Yes

The identity.id field.

country.id

string

Yes

Yes

The country.id field.

area.id

string

Yes

Yes

The area.id field.

city.id

string

Yes

Yes

The city.id field.

Sorting:

Value

Sorts by:

city_name

The first_name field.

postal_code

The last_name field.

address

The phone_number field.

description

The id_number field.

Examples

http

GET /v3/addresses HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i https://api.didww.com/v3/addresses -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
            "data": [
                {
                    "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
                    "type": "addresses",
                    "attributes": {
                        "city_name": "Antwerp",
                        "postal_code": "4641PA",
                        "address": "49th Ave",
                        "description": "Address of Rise Industries",
                        "created_at": "2020-09-16T10:23:07.846Z"
                    },
                    "relationships": {
                        "identity": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
                                "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
                            }
                        },
                        "country": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
                                "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
                            }
                        },
                        "proofs": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
                                "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
                            }
                        },
                "area": {
                  "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
                    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
                  }
                },
                "city": {
                  "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
                    "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
                  }
                }
                    }
                },
                {
                    "id": "f3f18701-356b-43dc-8a96-82d07af415cf",
                    "type": "addresses",
                    "attributes": {
                        "city_name": "Galway",
                        "postal_code": "Galway 17",
                        "address": "Street 15",
                        "description": "Headquarters",
                        "created_at": "2020-09-22T11:57:05.524Z"
                    },
                    "relationships": {
                        "identity": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/identity",
                                "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/identity"
                            }
                        },
                        "country": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/country",
                                "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/country"
                            }
                        },
                        "proofs": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/proofs",
                                "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/proofs"
                            }
                        },
                "area": {
                  "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/area",
                    "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/area"
                  }
                },
                "city": {
                  "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/city",
                    "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/city"
                  }
                }
                    }
                },
                {
                    "id": "54c92d8e-f135-4b55-ac48-748d44437509",
                    "type": "addresses",
                    "attributes": {
                        "city_name": "Dublin",
                        "postal_code": "Dublin 8",
                        "address": "10/13 Thomas Street",
                        "description": "My Business Address",
                        "created_at": "2020-09-14T07:29:41.413Z"
                    },
                    "relationships": {
                        "identity": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/identity",
                                "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/identity"
                            }
                        },
                        "country": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/country",
                                "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/country"
                            }
                        },
                        "proofs": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/proofs",
                                "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/proofs"
                            }
                        },
                "area": {
                  "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/area",
                    "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/area"
                  }
                },
                "city": {
                  "links": {
                    "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/city",
                    "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/city"
                  }
                }
                    }
                }
            ],
            "meta": {
                "total_records": 3,
                "api_version": "2021-04-19"
            },
            "links": {
                "first": "https://sandbox-api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50&sort=description",
                "last": "https://sandbox-api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50&sort=description"
            }
        }

Other Responses

Code

Success

Description

401

No

Unauthorized