Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ValidateE911Address

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Request Syntax


POST /emergency-calling/address HTTP/1.1
Content-type: application/json

{
   "AwsAccountId": "string",
   "City": "string",
   "Country": "string",
   "PostalCode": "string",
   "State": "string",
   "StreetInfo": "string",
   "StreetNumber": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AwsAccountId

The AWS account ID.

Type: String

Pattern: .*\S.*

Required: Yes

City

The address city, such as Portland.

Type: String

Pattern: .*\S.*

Required: Yes

Country

The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as US. For more information, see ISO 3166-1 alpha-2 in Wikipedia.

Type: String

Pattern: .*\S.*

Required: Yes

PostalCode

The dress postal code, such 04352.

Type: String

Pattern: .*\S.*

Required: Yes

State

The address state, such as ME.

Type: String

Pattern: .*\S.*

Required: Yes

StreetInfo

The address street information, such as 8th Avenue.

Type: String

Pattern: .*\S.*

Required: Yes

StreetNumber

The address street number, such as 200 or 2121.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "Address": { 
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "postalCodePlus4": "string",
      "postDirectional": "string",
      "preDirectional": "string",
      "state": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetSuffix": "string"
   },
   "AddressExternalId": "string",
   "CandidateAddressList": [ 
      { 
         "city": "string",
         "country": "string",
         "postalCode": "string",
         "postalCodePlus4": "string",
         "state": "string",
         "streetInfo": "string",
         "streetNumber": "string"
      }
   ],
   "ValidationResult": number
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

Address

The validated address.

Type: Address object

AddressExternalId

The ID that represents the address.

Type: String

CandidateAddressList

The list of address suggestions..

Type: Array of CandidateAddress objects

ValidationResult

Number indicating the result of address validation.

Each possible result is defined as follows:

0 - Address validation succeeded.
1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.
2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401