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 |
|
Yes |
Unique ID identifier of the Address Verification. |
Request Body Object Attributes#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
external_reference_id |
|
No |
Optional identifier for the verification task in the customer’s external system. Maximum length is 100 characters. |
Examples#
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
5Api-Key: [API 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 "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --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": [],
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-04-16"
36 }
37}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |