Get Address Verification#

Returns a single address verification status and reason if the verification was rejected.

Request#

HTTP Method: GET

URI Path: /v3/address_verifications/{id}

Note

For all returned data attributes, see Address Verifications Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Address Verification.

include

string

No

Inclusion

Includes#

Value

Description

address

Addresses Object

dids

DID Object

dids.did_group

DID Group Object

Examples#

http

1GET /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]

curl

1curl -i -X GET 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]"

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": null,
10            "service_description": null,
11            "callback_url": null,
12            "callback_method": null,
13            "status": "approved",
14            "reject_reasons": null,
15            "reject_comment": null,
16            "created_at": "2020-09-15T06:38:12.650Z",
17            "reference": "SHB-485120"
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}

Other Responses#

Code

Success

Description

404

No

Not Found. No address verification with that id belongs to the account.

401

No

Unauthorized

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.