Emergency Requirement Validations#
Checks if the Address and/or
Identity created is valid against the
Emergency Requirement. The JSON:API resource
type is emergency_requirement_validations.
Request#
HTTP Method: POST
URI Path: /v3/emergency_requirement_validations
Request Body Object Relationships#
Title |
Type |
Description |
|---|---|---|
emergency_requirement |
Specifies the emergency requirement ID. |
|
identity |
Specifies the identity ID. |
|
address |
Specifies the address ID. |
Examples#
http
1POST /v3/emergency_requirement_validations HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
6
7{
8 "data": {
9 "type": "emergency_requirement_validations",
10 "relationships": {
11 "emergency_requirement": {
12 "data": {
13 "id": "ID_of_Emergency_Requirement",
14 "type": "emergency_requirements"
15 }
16 },
17 "address": {
18 "data": {
19 "id": "ID_of_Address",
20 "type": "addresses"
21 }
22 },
23 "identity": {
24 "data": {
25 "id": "ID_of_Identity",
26 "type": "identities"
27 }
28 }
29 }
30 }
31}
curl
1curl -i -X POST https://api.didww.com/v3/emergency_requirement_validations -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"relationships": {"address": {"data": {"id": "ID_of_Address", "type": "addresses"}}, "emergency_requirement": {"data": {"id": "ID_of_Emergency_Requirement", "type": "emergency_requirements"}}, "identity": {"data": {"id": "ID_of_Identity", "type": "identities"}}}, "type": "emergency_requirement_validations"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
7 "type": "emergency_requirement_validations"
8 },
9 "meta": {
10 "api_version": "2026-11-19"
11 }
12}
http
1POST /v3/emergency_requirement_validations HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
6
7{
8 "data": {
9 "type": "emergency_requirement_validations",
10 "relationships": {
11 "emergency_requirement": {
12 "data": {
13 "id": "ID_of_Emergency_Requirement",
14 "type": "emergency_requirements"
15 }
16 },
17 "address": {
18 "data": {
19 "id": "ID_of_Address",
20 "type": "addresses"
21 }
22 },
23 "identity": {
24 "data": {
25 "id": "ID_of_Identity",
26 "type": "identities"
27 }
28 }
29 }
30 }
31}
curl
1curl -i -X POST https://api.didww.com/v3/emergency_requirement_validations -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"relationships": {"address": {"data": {"id": "ID_of_Address", "type": "addresses"}}, "emergency_requirement": {"data": {"id": "ID_of_Emergency_Requirement", "type": "emergency_requirements"}}, "identity": {"data": {"id": "ID_of_Identity", "type": "identities"}}}, "type": "emergency_requirement_validations"}}'
response
1HTTP/1.1 422 Unprocessable Entity
2Content-Type: application/vnd.api+json
3
4{
5 "errors": [
6 {
7 "title": "Address in United States required",
8 "detail": "Address in United States required",
9 "code": "100",
10 "source": {
11 "pointer": "/data"
12 },
13 "status": "422"
14 },
15 {
16 "title": "Following mandatory fields are not filled (Birth Date)",
17 "detail": "Following mandatory fields are not filled (Birth Date)",
18 "code": "100",
19 "source": {
20 "pointer": "/data"
21 },
22 "status": "422"
23 }
24 ]
25}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
Bad Request. The body carries a member the API does not accept. |
401 |
No |
|
403 |
No |
Forbidden. Emergency calling is not enabled for the account. Also returned when the access token carries the |
422 |
No |
Validation Error Object. The requirement is not satisfied. |
429 |
No |
The request budget of the account for the current window is spent ( |