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/

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

Approved VerificationRejected Verification

http

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

curl

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

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": null,
            "service_description": null,
            "callback_url": null,
            "callback_method": null,
            "status": "approved",
            "reject_reasons": [],
            "reject_comment": null,
            "created_at": "2020-09-15T06:38:12.650Z",
            "reference": "SHB-485120"
        },
        "relationships": {
            "dids": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/dids",
                    "related": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/dids"
                }
            },
            "address": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/address",
                    "related": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/address"
                }
            }
        }
    },
    "meta": {
        "api_version": "2026-04-16"
    }
}

Other Responses

Code	Success	Description
401	No	Unauthorized