Update Addresses#

Update the settings of a single Address owned by your account.

Request#

HTTP Method: PATCH

URI Path: /v3/addresses/{id}

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID number allocated to this Address.

Attributes#

Name

Type

Is Required?

Description

city_name

string

No

City name of the address.

postal_code

string

No

Postal code of the address.

address

string

No

Full address.

description

string

No

The description of the address.

external_reference_id

string

No

Optional identifier for the address in the customer’s external system. Maximum length is 100 characters.

Examples#

http

 1PATCH /v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0 HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
10    "type": "addresses",
11    "attributes": {
12      "city_name": "string",
13      "postal_code": "string",
14      "address": "string",
15      "description": "string"
16    }
17  }
18}

curl

1curl -i -X PATCH https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"address": "string", "city_name": "string", "description": "string", "postal_code": "string"}, "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0", "type": "addresses"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
 7    "type": "addresses",
 8    "attributes": {
 9      "city_name": "string",
10      "postal_code": "string",
11      "address": "string",
12      "description": "string",
13      "created_at": "2020-09-16T10:23:07.846Z",
14      "verified": false,
15      "external_reference_id": null
16    },
17    "relationships": {
18      "identity": {
19        "links": {
20          "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
21          "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
22        }
23      },
24      "country": {
25        "links": {
26          "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
27          "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
28        }
29      },
30      "proofs": {
31        "links": {
32          "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
33          "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
34        }
35      },
36      "area": {
37        "links": {
38          "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
39          "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
40        }
41      },
42      "city": {
43        "links": {
44          "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
45          "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
46        }
47      }
48    }
49  },
50  "meta": {
51    "api_version": "2026-11-19"
52  }
53}

Other Responses#

Code

Success

Description

404

No

Not Found

400

No

Bad Request. The body carries a member the API does not accept.

401

No

Unauthorized

403

No

The access token carries the read scope, which does not cover this method (title Insufficient scope). The response carries WWW-Authenticate: Bearer error="insufficient_scope". See Scopes.

422

No

Unprocessable Entity. For example, external_reference_id is longer than 100 characters.

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.