Get DID#
Returns a single DID owned by your account.
Request#
HTTP Method: GET
URI Path: /v3/dids/{id}
Note
For all returned data attributes, see Did Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the DID. |
include |
|
No |
Related resources to include in the response. See Inclusion. |
fields[dids] |
|
No |
Includes#
Value |
Description |
|---|---|
order |
|
voice_in_trunk |
|
voice_in_trunk.voice_in_trunk_group |
|
voice_in_trunk_group |
|
sms_trunk |
|
sms_trunk_group |
|
capacity_pool |
|
shared_capacity_group |
|
did_group |
|
identity |
|
emergency_calling_service |
|
emergency_verification |
|
address_verification |
|
did_group.country |
|
did_group.city |
|
did_group.region |
|
did_group.stock_keeping_units |
Object Relationships#
Value |
Description |
|---|---|
order |
|
voice_in_trunk |
|
voice_in_trunk.voice_in_trunk_group |
|
voice_in_trunk_group |
|
sms_trunk |
|
sms_trunk_group |
|
capacity_pool |
|
shared_capacity_group |
|
did_group |
|
identity |
|
emergency_calling_service |
Emergency Calling Service resource |
emergency_verification |
Emergency Verification resource |
did_group.country |
|
did_group.city |
|
did_group.region |
|
did_group.stock_keeping_units |
Examples#
http
1GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284 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/dids/44957076-778a-4802-b60c-d22db0cda284 -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": "44957076-778a-4802-b60c-d22db0cda284",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
32 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1GET /v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d?include=did_group 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/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d?include=did_group' -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": "2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/did_group"
27 },
28 "data": {
29 "type": "did_groups",
30 "id": "d04b6466-3d98-4be1-aac5-93ee241f57ca"
31 }
32 },
33 "order": {
34 "links": {
35 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/order",
36 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/order"
37 }
38 },
39 "voice_in_trunk": {
40 "links": {
41 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk",
42 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk"
43 }
44 },
45 "voice_in_trunk_group": {
46 "links": {
47 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk_group",
48 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk_group"
49 }
50 },
51 "capacity_pool": {
52 "links": {
53 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/capacity_pool",
54 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/capacity_pool"
55 }
56 },
57 "shared_capacity_group": {
58 "links": {
59 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/shared_capacity_group",
60 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/shared_capacity_group"
61 }
62 },
63 "sms_trunk": {
64 "links": {
65 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/sms_trunk",
66 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/sms_trunk"
67 }
68 },
69 "sms_trunk_group": {
70 "links": {
71 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/sms_trunk_group",
72 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/sms_trunk_group"
73 }
74 },
75 "address_verification": {
76 "links": {
77 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/address_verification",
78 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/address_verification"
79 }
80 },
81 "emergency_calling_service": {
82 "links": {
83 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/emergency_calling_service",
84 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/emergency_calling_service"
85 }
86 },
87 "emergency_verification": {
88 "links": {
89 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/emergency_verification",
90 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/emergency_verification"
91 }
92 },
93 "identity": {
94 "links": {
95 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/identity",
96 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/identity"
97 }
98 }
99 }
100 },
101 "included": [
102 {
103 "id": "d04b6466-3d98-4be1-aac5-93ee241f57ca",
104 "type": "did_groups",
105 "attributes": {
106 "prefix": "721",
107 "features": [
108 "voice_in"
109 ],
110 "is_metered": false,
111 "area_name": "National",
112 "allow_additional_channels": true,
113 "service_restrictions": null,
114 "number_type": "national",
115 "is_demo": false
116 },
117 "relationships": {
118 "country": {
119 "links": {
120 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/country",
121 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/country"
122 }
123 },
124 "city": {
125 "links": {
126 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/city",
127 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/city"
128 }
129 },
130 "region": {
131 "links": {
132 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/region",
133 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/region"
134 }
135 },
136 "stock_keeping_units": {
137 "links": {
138 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/stock_keeping_units",
139 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/stock_keeping_units"
140 }
141 },
142 "address_requirement": {
143 "links": {
144 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/address_requirement",
145 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/address_requirement"
146 }
147 }
148 },
149 "meta": {
150 "available_dids_enabled": false,
151 "needs_registration": false,
152 "is_available": true,
153 "total_count": 7
154 }
155 }
156 ],
157 "meta": {
158 "api_version": "2026-11-19"
159 }
160}
http
1GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284?include=identity 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/dids/44957076-778a-4802-b60c-d22db0cda284?include=identity' -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": "44957076-778a-4802-b60c-d22db0cda284",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
32 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
93 },
94 "data": {
95 "type": "identities",
96 "id": "9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41"
97 }
98 }
99 }
100 },
101 "included": [
102 {
103 "id": "9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41",
104 "type": "identities",
105 "attributes": {
106 "first_name": "John",
107 "last_name": "Doe",
108 "phone_number": "1276813663",
109 "id_number": null,
110 "birth_date": "1985-02-10",
111 "company_name": null,
112 "company_website": null,
113 "company_reg_number": null,
114 "vat_id": null,
115 "description": null,
116 "personal_tax_id": null,
117 "identity_type": "personal",
118 "created_at": "2025-04-11T13:03:17.029Z",
119 "external_reference_id": null,
120 "verified": false,
121 "contact_email": "john.doe@example.com"
122 },
123 "relationships": {
124 "country": {
125 "links": {
126 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/country",
127 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/country"
128 }
129 },
130 "birth_country": {
131 "links": {
132 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/birth_country",
133 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/birth_country"
134 }
135 },
136 "proofs": {
137 "links": {
138 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/proofs",
139 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/proofs"
140 }
141 },
142 "addresses": {
143 "links": {
144 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/addresses",
145 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/addresses"
146 }
147 },
148 "permanent_documents": {
149 "links": {
150 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/permanent_documents",
151 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/permanent_documents"
152 }
153 }
154 }
155 }
156 ],
157 "meta": {
158 "api_version": "2026-11-19"
159 }
160}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |