Create Emergency Verification#
Creates a new emergency verification, either for a new Emergency Calling Service or for resubmitting a rejected or updating an existing one.
Request#
HTTP Method: POST
URI Path: /v3/emergency_verifications
Request Body Object Attributes#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
callback_url |
|
No |
The HTTP or HTTPS endpoint to where events related to the verification will be delivered. |
callback_method |
|
No |
The callback method used for verification events. Supported methods: |
external_reference_id |
|
No |
Optional identifier for the emergency verification in the customer’s external system. Maximum length is 100 characters. |
See Emergency Verification callback details
for information about callback_url, callback_method, and the callback payload.
Request Body Object Relationships#
Title |
Type |
Description |
|---|---|---|
address |
Specifies the emergency address ID. |
|
dids |
Specifies the DID IDs for a new Emergency Calling Service. At least one DID is required when |
|
emergency_calling_service |
Specifies the existing Emergency Calling Service ID when resubmitting or updating the address of an existing service. |
Note
New Calling Service mode uses
addressanddidsrelationships and does not sendemergency_calling_service.Existing Calling Service mode uses
emergency_calling_serviceandaddressrelationships and does not senddids.Address updates are allowed only when the Emergency Calling Service status is
new,changes_required, oractive.Requests return
422when the Emergency Calling Service is inpending_update,in_process, orcanceledstatus.
Examples#
http
1POST /v3/emergency_verifications HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
6
7{
8 "data": {
9 "type": "emergency_verifications",
10 "attributes": {
11 "callback_url": "https://example.com/callbacks/emergency",
12 "callback_method": "post"
13 },
14 "relationships": {
15 "address": {
16 "data": {
17 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
18 "type": "addresses"
19 }
20 },
21 "dids": {
22 "data": [
23 {
24 "id": "f10d40c7-fd0b-4d63-bb9b-27810a1a8f5c",
25 "type": "dids"
26 },
27 {
28 "id": "a2b3c4d5-e6f7-8901-abcd-ef1234567890",
29 "type": "dids"
30 }
31 ]
32 }
33 }
34 }
35}
curl
1curl -i -X POST https://api.didww.com/v3/emergency_verifications -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"callback_method": "post", "callback_url": "https://example.com/callbacks/emergency"}, "relationships": {"address": {"data": {"id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0", "type": "addresses"}}, "dids": {"data": [{"id": "f10d40c7-fd0b-4d63-bb9b-27810a1a8f5c", "type": "dids"}, {"id": "a2b3c4d5-e6f7-8901-abcd-ef1234567890", "type": "dids"}]}}, "type": "emergency_verifications"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "89c0164e-752f-4995-a0fa-0ced21e60e4a",
7 "type": "emergency_verifications",
8 "attributes": {
9 "reference": "SHB-485120",
10 "status": "pending",
11 "reject_reasons": [],
12 "reject_comment": null,
13 "callback_url": "https://example.com/callbacks/emergency",
14 "callback_method": "post",
15 "created_at": "2026-03-20T12:20:04.584Z",
16 "external_reference_id": "test"
17 },
18 "relationships": {
19 "address": {
20 "data": {
21 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
22 "type": "addresses"
23 }
24 },
25 "emergency_calling_service": {
26 "data": {
27 "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
28 "type": "emergency_calling_services"
29 }
30 },
31 "dids": {
32 "data": [
33 {
34 "id": "f10d40c7-fd0b-4d63-bb9b-27810a1a8f5c",
35 "type": "dids"
36 },
37 {
38 "id": "a2b3c4d5-e6f7-8901-abcd-ef1234567890",
39 "type": "dids"
40 }
41 ]
42 }
43 }
44 },
45 "meta": {
46 "api_version": "2026-04-16"
47 }
48}
http
1POST /v3/emergency_verifications HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
6
7{
8 "data": {
9 "type": "emergency_verifications",
10 "attributes": {
11 "callback_url": "https://example.com/callbacks/emergency",
12 "callback_method": "post"
13 },
14 "relationships": {
15 "address": {
16 "data": {
17 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
18 "type": "addresses"
19 }
20 },
21 "emergency_calling_service": {
22 "data": {
23 "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
24 "type": "emergency_calling_services"
25 }
26 }
27 }
28 }
29}
curl
1curl -i -X POST https://api.didww.com/v3/emergency_verifications -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"callback_method": "post", "callback_url": "https://example.com/callbacks/emergency"}, "relationships": {"address": {"data": {"id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0", "type": "addresses"}}, "emergency_calling_service": {"data": {"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "type": "emergency_calling_services"}}}, "type": "emergency_verifications"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "d4e5f6a7-b8c9-0123-def0-123456789012",
7 "type": "emergency_verifications",
8 "attributes": {
9 "reference": "SHB-998877",
10 "status": "pending",
11 "reject_reasons": [],
12 "reject_comment": null,
13 "callback_url": "https://example.com/callbacks/emergency",
14 "callback_method": "post",
15 "created_at": "2026-03-23T09:15:00.000Z",
16 "external_reference_id": "test"
17 },
18 "relationships": {
19 "address": {
20 "data": {
21 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
22 "type": "addresses"
23 }
24 },
25 "emergency_calling_service": {
26 "data": {
27 "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
28 "type": "emergency_calling_services"
29 }
30 },
31 "dids": {
32 "data": []
33 }
34 }
35 },
36 "meta": {
37 "api_version": "2026-04-16"
38 }
39}
http
1POST /v3/emergency_verifications HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
6
7{
8 "data": {
9 "type": "emergency_verifications",
10 "attributes": {
11 "callback_url": "https://example.com/callbacks/emergency",
12 "callback_method": "post"
13 },
14 "relationships": {
15 "address": {
16 "data": {
17 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
18 "type": "addresses"
19 }
20 },
21 "dids": {
22 "data": []
23 }
24 }
25 }
26}
curl
1curl -i -X POST https://api.didww.com/v3/emergency_verifications -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"callback_method": "post", "callback_url": "https://example.com/callbacks/emergency"}, "relationships": {"address": {"data": {"id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0", "type": "addresses"}}, "dids": {"data": []}}, "type": "emergency_verifications"}}'
response
1HTTP/1.1 422 Unprocessable Entity
2Content-Type: application/vnd.api+json
3
4{
5 "errors": [
6 {
7 "title": "can't be blank",
8 "detail": "dids - can't be blank",
9 "code": "100",
10 "source": {
11 "pointer": "/data/relationships/dids"
12 },
13 "status": "422"
14 }
15 ]
16}
http
1POST /v3/emergency_verifications HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
6
7{
8 "data": {
9 "type": "emergency_verifications",
10 "attributes": {
11 "callback_url": "https://example.com/callbacks/emergency",
12 "callback_method": "post"
13 },
14 "relationships": {
15 "address": {
16 "data": {
17 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
18 "type": "addresses"
19 }
20 },
21 "dids": {
22 "data": [
23 {
24 "id": "2ae7bae7-bf6d-4149-a45c-2d28d636a8d6",
25 "type": "dids"
26 }
27 ]
28 }
29 }
30 }
31}
curl
1curl -i -X POST https://api.didww.com/v3/emergency_verifications -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"callback_method": "post", "callback_url": "https://example.com/callbacks/emergency"}, "relationships": {"address": {"data": {"id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0", "type": "addresses"}}, "dids": {"data": [{"id": "2ae7bae7-bf6d-4149-a45c-2d28d636a8d6", "type": "dids"}]}}, "type": "emergency_verifications"}}'
response
1HTTP/1.1 422 Unprocessable Entity
2Content-Type: application/vnd.api+json
3
4{
5 "errors": [
6 {
7 "title": "Emergency Rate not found",
8 "detail": "Emergency Rate not found",
9 "code": "100",
10 "source": {
11 "pointer": "/data"
12 },
13 "status": "422"
14 },
15 {
16 "title": "should have the same Did Group Type",
17 "detail": "dids - should have the same Did Group Type",
18 "code": "100",
19 "source": {
20 "pointer": "/data/relationships/dids"
21 },
22 "status": "422"
23 },
24 {
25 "title": "should be linked with City ID",
26 "detail": "dids - should be linked with City ID",
27 "code": "100",
28 "source": {
29 "pointer": "/data/relationships/dids"
30 },
31 "status": "422"
32 },
33 {
34 "title": "does not support Emergency feature",
35 "detail": "dids/2ae7bae7-bf6d-4149-a45c-2d28d636a8d6 - does not support Emergency feature",
36 "code": "100",
37 "source": {
38 "pointer": "/data/relationships/dids/2ae7bae7-bf6d-4149-a45c-2d28d636a8d6"
39 },
40 "status": "422"
41 }
42 ]
43}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
Invalid resource for earlier API versions. |
401 |
No |
|
403 |
No |
Forbidden. Example detail: |