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
PATCH /v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"id": "c8e004b0-87ec-4987-b4fb-ee89db099f0e",
"type": "address_verifications",
"attributes": {
"external_reference_id": "test"
}
}
}
curl
curl -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
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "c8e004b0-87ec-4987-b4fb-ee89db099f0e",
"type": "address_verifications",
"attributes": {
"external_reference_id": "test",
"service_description": null,
"callback_url": null,
"callback_method": null,
"status": "approved",
"reject_reasons": [],
"reject_comment": null,
"reference": "SHB-485120",
"created_at": "2020-09-15T06:38:12.650Z"
},
"relationships": {
"dids": {
"links": {
"self": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/dids",
"related": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/dids"
}
},
"address": {
"links": {
"self": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/address",
"related": "https://api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/address"
}
}
}
},
"meta": {
"api_version": "2026-04-16"
}
}
Other Responses
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |