# Get Address Verifications Returns the address verifications status and reasons if the verification was rejected. ## Request HTTP Method: `GET` URI Path: `/v3/address_verifications` Note For all returned data attributes, see [Address Verifications Object](address-verifications-object.html). ### URI Query Parameters | Name | Type | Is Required? | Description | | --- | --- | --- | --- | | include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) | | filter[] | `string` | No | [Filtering](../../../specification/filtering.html#api-filters) | | fields[address\_verifications] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) | | sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) | ### Includes | Value | Description | | --- | --- | | address | [Addresses Object](../addresses/address-object.html#addresses-object-v34) | | dids | [DID Object](../../inventory-resources/did/did-object.html#did-object-v34) | | dids.did\_group | [DID Group Object](../../coverage-resources/did-group/did-group-object.html#did-group-object-v34) | ### Filters | Filter Name | Type | Allow Blank | Allow Array | Filters by: | | --- | --- | --- | --- | --- | | address.id | `string` | Yes | Yes | The `address.id` field. | | address.identity.id | `string` | Yes | Yes | The `address.identity.id` field. | | status | `string` | No | No | The `status` field. Possible values: `pending`, `approved`, `rejected`. | | reference | `string` | No | Yes | The `reference` field. | | external\_reference\_id | `string` | No | No | The `external_reference_id` field. | ### Sorting | Value | Sorts by: | | --- | --- | | created\_at | The `created_at` field. | | external\_reference\_id | The `external_reference_id` field. | ## Examples Simple RequestFilter by statusInclude dids [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/address_verifications 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 -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": "40c315d2-255c-410f-9af7-6b288c3f8ba4", "type": "address_verifications", "attributes": { "external_reference_id": null, "service_description": "testing", "callback_url": null, "callback_method": null, "status": "rejected", "reject_reasons": [ "The proof of personal address is required", "The DID cannot be used for the indicated service" ], "reject_comment": "Additional info from operator", "reference": "EGE-764403", "created_at": "2021-03-22T06:24:58.295Z" }, "relationships": { "dids": { "links": { "self": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/dids", "related": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/dids" } }, "address": { "links": { "self": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/address", "related": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/address" } } } } ], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://sandbox-api.didww.com/v3/address_verifications?page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://sandbox-api.didww.com/v3/address_verifications?page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/address_verifications?filter%5Bstatus%5D=rejected 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?filter%5Bstatus%5D=rejected' -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": "40c315d2-255c-410f-9af7-6b288c3f8ba4", "type": "address_verifications", "attributes": { "external_reference_id": null, "service_description": "testing", "callback_url": null, "callback_method": null, "status": "rejected", "reject_reasons": [ "The proof of personal address is required", "The DID cannot be used for the indicated service" ], "reject_comment": "Additional info from operator", "reference": "EGE-764403", "created_at": "2021-03-22T06:24:58.295Z" }, "relationships": { "dids": {"links": { "self": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/dids", "related": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/dids" }}, "address": {"links": { "self": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/address", "related": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/address" }} } }], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/address_verifications?filter%5Bstatus%5D=rejected&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/address_verifications?filter%5Bstatus%5D=rejected&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/address_verifications?include=dids 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?include=dids' -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": "9814cf4f-b472-4ea7-9275-565eb90be397", "type": "address_verifications", "attributes": { "service_description": null, "callback_url": "http://192.0.2.10/test.php", "callback_method": "get", "status": "rejected", "reject_reasons": [ "The proof of personal address is required", "The DID cannot be used for the indicated service" ], "reject_comment": "Additional info from operator", "reference": "XNH-144620", "created_at": "2021-08-11T15:43:23.263Z" }, "relationships": { "dids": { "links": { "self": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/relationships/dids", "related": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/dids" }, "data": [ { "type": "dids", "id": "9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc" }] }, "address": {"links": { "self": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/relationships/address", "related": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/address" }} } }], "included": [ { "id": "9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc", "type": "dids", "attributes": { "blocked": true, "capacity_limit": 55, "description": null, "terminated": false, "awaiting_registration": true, "created_at": "2018-11-28T09:40:31.684Z", "billing_cycles_count": null, "number": "4921111111111", "expires_at": "2021-08-19T17:32:21.390Z", "channels_included_count": 2, "dedicated_channels_count": 0 }, "relationships": { "did_group": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/did_group", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/did_group" }}, "order": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/order", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/order" }}, "voice_in_trunk": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/voice_in_trunk", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/voice_in_trunk" }}, "voice_in_trunk_group": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/voice_in_trunk_group", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/voice_in_trunk_group" }}, "capacity_pool": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/capacity_pool", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/capacity_pool" }}, "shared_capacity_group": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/shared_capacity_group", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/shared_capacity_group" }}, "address_verification": {"links": { "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/address_verification", "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/address_verification" }} } }], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/address_verifications?include=dids&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/address_verifications?include=dids&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] ## Other Responses | Code | Success | Description | | --- | --- | --- | | 401 | No | [Unauthorized](../../../configuration.html#api-key) | On this page