# 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[<filter\_name>] | `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) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). Pagination defaults to `50` records per page. The maximum is `100`. |

### Includes

| Value | Description |
| --- | --- |
| address | [Addresses Object](../addresses/address-object.html#addresses-object-v35) |
| dids | [DID Object](../../inventory-resources/did/did-object.html#did-object-v35) |
| dids.did\_group | [DID Group Object](../../coverage-resources/did-group/did-group-object.html#did-group-object-v35) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | The `id` field. |
| address.id | `string` | Yes | Yes | The `address.id` field. |
| reference\_in | `string` | No | Yes | The `reference` field, matching any of the listed values. |
| 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 | No | The `reference` field contains. |
| 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

```
1GET /v3/address_verifications 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 -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      {
 7            "id": "40c315d2-255c-410f-9af7-6b288c3f8ba4",
 8            "type": "address_verifications",
 9            "attributes": {
10               "external_reference_id": null,
11               "service_description": "testing",
12               "callback_url": null,
13               "callback_method": null,
14               "status": "rejected",
15               "reject_reasons": [
16                  "The proof of personal address is required",
17                  "The DID cannot be used for the indicated service"
18               ],
19               "reject_comment": "Additional info from operator",
20               "reference": "EGE-764403",
21               "created_at": "2021-03-22T06:24:58.295Z"
22            },
23            "relationships": {
24               "dids": {
25                  "links": {
26                        "self": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/dids",
27                        "related": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/dids"
28                  }
29               },
30               "address": {
31                  "links": {
32                        "self": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/address",
33                        "related": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/address"
34                  }
35               }
36            }
37      }
38   ],
39   "meta": {
40      "total_records": 1,
41      "api_version": "2026-11-19"
42   },
43   "links": {
44      "first": "https://api.didww.com/v3/address_verifications?page%5Bnumber%5D=1&page%5Bsize%5D=50",
45      "last": "https://api.didww.com/v3/address_verifications?page%5Bnumber%5D=1&page%5Bsize%5D=50"
46   }
47}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/address_verifications?filter%5Bstatus%5D=rejected 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?filter%5Bstatus%5D=rejected' -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": "40c315d2-255c-410f-9af7-6b288c3f8ba4",
 7      "type": "address_verifications",
 8      "attributes":       {
 9         "external_reference_id": null,
10         "service_description": "testing",
11         "callback_url": null,
12         "callback_method": null,
13         "status": "rejected",
14         "reject_reasons": [
15            "The proof of personal address is required",
16            "The DID cannot be used for the indicated service"
17         ],
18         "reject_comment": "Additional info from operator",
19         "reference": "EGE-764403",
20         "created_at": "2021-03-22T06:24:58.295Z"
21      },
22      "relationships":       {
23         "dids": {"links":          {
24            "self": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/dids",
25            "related": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/dids"
26         }},
27         "address": {"links":          {
28            "self": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/address",
29            "related": "https://api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/address"
30         }}
31      }
32   }],
33   "meta":    {
34      "total_records": 1,
35      "api_version": "2026-11-19"
36   },
37   "links":    {
38      "first": "https://api.didww.com/v3/address_verifications?filter%5Bstatus%5D=rejected&page%5Bnumber%5D=1&page%5Bsize%5D=50",
39      "last": "https://api.didww.com/v3/address_verifications?filter%5Bstatus%5D=rejected&page%5Bnumber%5D=1&page%5Bsize%5D=50"
40   }
41}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/address_verifications?include=dids 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?include=dids' -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": "9814cf4f-b472-4ea7-9275-565eb90be397",
  7      "type": "address_verifications",
  8      "attributes":       {
  9         "external_reference_id": null,
 10         "service_description": null,
 11         "callback_url": "http://192.0.2.10/test.php",
 12         "callback_method": "get",
 13         "status": "rejected",
 14         "reject_reasons": [
 15            "The proof of personal address is required",
 16            "The DID cannot be used for the indicated service"
 17         ],
 18         "reject_comment": "Additional info from operator",
 19         "reference": "XNH-144620",
 20         "created_at": "2021-08-11T15:43:23.263Z"
 21      },
 22      "relationships":       {
 23         "dids":          {
 24            "links":             {
 25               "self": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/relationships/dids",
 26               "related": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/dids"
 27            },
 28            "data": [            {
 29               "type": "dids",
 30               "id": "9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc"
 31            }]
 32         },
 33         "address": {"links":          {
 34            "self": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/relationships/address",
 35            "related": "https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/address"
 36         }}
 37      }
 38   }],
 39   "included": [   {
 40      "id": "9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc",
 41      "type": "dids",
 42      "attributes":       {
 43         "blocked": true,
 44         "capacity_limit": 55,
 45         "description": null,
 46         "terminated": false,
 47         "awaiting_registration": true,
 48         "created_at": "2018-11-28T09:40:31.684Z",
 49         "billing_cycles_count": null,
 50         "number": "4921111111111",
 51         "expires_at": "2021-08-19T17:32:21.390Z",
 52         "channels_included_count": 2,
 53         "dedicated_channels_count": 0,
 54         "emergency_enabled": false
 55      },
 56      "relationships":       {
 57         "did_group": {"links":          {
 58            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/did_group",
 59            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/did_group"
 60         }},
 61         "order": {"links":          {
 62            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/order",
 63            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/order"
 64         }},
 65         "voice_in_trunk": {"links":          {
 66            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/voice_in_trunk",
 67            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/voice_in_trunk"
 68         }},
 69         "voice_in_trunk_group": {"links":          {
 70            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/voice_in_trunk_group",
 71            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/voice_in_trunk_group"
 72         }},
 73         "capacity_pool": {"links":          {
 74            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/capacity_pool",
 75            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/capacity_pool"
 76         }},
 77         "shared_capacity_group": {"links":          {
 78            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/shared_capacity_group",
 79            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/shared_capacity_group"
 80         }},
 81         "sms_trunk": {
 82            "links": {
 83               "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/sms_trunk",
 84               "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/sms_trunk"
 85            }
 86         },
 87         "sms_trunk_group": {
 88            "links": {
 89               "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/sms_trunk_group",
 90               "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/sms_trunk_group"
 91            }
 92         },
 93         "address_verification": {"links":          {
 94            "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/address_verification",
 95            "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/address_verification"
 96         }},
 97         "emergency_calling_service": {
 98            "links": {
 99               "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/emergency_calling_service",
100               "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/emergency_calling_service"
101            }
102         },
103         "emergency_verification": {
104            "links": {
105               "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/emergency_verification",
106               "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/emergency_verification"
107            }
108         },
109         "identity": {
110            "links": {
111               "self": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/identity",
112               "related": "https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/identity"
113            }
114         }
115      }
116   }],
117   "meta":    {
118      "total_records": 1,
119      "api_version": "2026-11-19"
120   },
121   "links":    {
122      "first": "https://api.didww.com/v3/address_verifications?include=dids&page%5Bnumber%5D=1&page%5Bsize%5D=50",
123      "last": "https://api.didww.com/v3/address_verifications?include=dids&page%5Bnumber%5D=1&page%5Bsize%5D=50"
124   }
125}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request). Malformed request: unknown filter, bad pagination or bad sort field. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 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. |
