# Update Address Verification

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

Only `external_reference_id` can be updated.

## Request

HTTP Method: `PATCH`

URI Path: `/v3/address_verifications/{id}`

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| id | `string` | Yes | Unique ID identifier of the Address Verification. |

### Request Body Object Attributes

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| external\_reference\_id | `string` | No | Optional identifier for the verification task in the customer's external system. Maximum length is 100 characters. |

## Examples

Update external\_reference\_id

[[DIDWW-API-EXAMPLE-START]]

http

```
 1PATCH /v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e 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": "c8e004b0-87ec-4987-b4fb-ee89db099f0e",
10    "type": "address_verifications",
11    "attributes": {
12      "external_reference_id": "test"
13    }
14  }
15}
```

curl

```
1curl -i -X PATCH https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"external_reference_id": "test"}, "id": "c8e004b0-87ec-4987-b4fb-ee89db099f0e", "type": "address_verifications"}}'
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "c8e004b0-87ec-4987-b4fb-ee89db099f0e",
 7    "type": "address_verifications",
 8    "attributes": {
 9      "external_reference_id": "test",
10      "service_description": null,
11      "callback_url": null,
12      "callback_method": null,
13      "status": "approved",
14      "reject_reasons": null,
15      "reject_comment": null,
16      "reference": "SHB-485120",
17      "created_at": "2020-09-15T06:38:12.650Z"
18    },
19    "relationships": {
20      "dids": {
21        "links": {
22          "self": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/dids",
23          "related": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/dids"
24        }
25      },
26      "address": {
27        "links": {
28          "self": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/address",
29          "related": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/address"
30        }
31      }
32    }
33  },
34  "meta": {
35    "api_version": "2026-11-19"
36  }
37}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 404 | No | [Not Found](../../../specification/errors/index.html#api-not-found) |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request). The body carries a member the API does not accept. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 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](../../authentication.html#authentication-scopes-v35). |
| 422 | No | [Validation Error Object](../../../specification/errors/index.html#api-validation-error-object). `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. |
