Create and Validate a New E911 Address

Lets you create and validate an E911 address within the US and Canada which can then be assigned to any of the long code numbers on your account. To assign an E911 address to your number, see Assign a Valid E911 Address to Your Phone Number.

NOTE: you cannot assign an E911 address to a Toll-Free number.

Enhanced 911 (E911)

Flowroute employs an Enhanced 911 integration which is an enhanced version of the 911 system used in the United States for calls seeking emergency assistance such as police, fire, and ambulance services. Calls to 911 are routed to a Public Safety Answering Point (PSAP) – E911 identifies the location of the caller and routes the call to the appropriate local PSAP, and provides the PSAP with location information in order to speed up the response.

The data supplied to the PSAP must be in a specific format and must be verified prior to assignment to a TN. To this end, if you supply your address to the E911 service, it may require adjustment and formatting changes to match the required format of the PSAP. If this happens, your request will return an error and will specifiy the required format changes.

Endpoint

POST /e911s

Body Parameters

  • data
    object REQUIRED

    E911 object to be added which is composed of type and attributes.

    • type
      string REQUIRED

      Object type. This will always be e911.

    • attributes
      object REQUIRED

      Object composed of the following required attributes of an E911 object:

      • label string- Unique friendly name for the E911 address to be validated and added to your account.

      • first_name string- First name to be associated with the E911 address to be added.

      • last_name string- Last name to be associated with the E911 address to be added.

      • street_number integer- The street number of the E911 address to be validated and added to your account.

      • street_name string- The street name of the E911 address to be validated and added to your account.

      • city string- City where the E911 address to be validated and added to your account is located.

      • address_type string- Address type for the E911 address to be validated and added to your account, if applicable. You can set the address type to any of the following case-insensitive options:

        • Apartment
        • Basement
        • Building
        • Department
        • Floor
        • Front
        • Key
        • Lobby
        • Lot
        • Lower
        • Office
        • Penthouse
        • Pier
        • Rear
        • Room
        • Side
        • Slip
        • Space
        • Stop
        • Suite
        • Trailer
        • Unit
        • Upper

      • address_type_number string- Identifier associated with the address type. For example, A-1 Required if the E911 address to be validated contains an address type.

      • state string- Two-letter abbreviated US state or Canadian province or territory in uppercase where the E911 city is located.

      • country string- Two-letter abbreviated country code in uppercase where the city and state or province of the E911 address are located. Valid options are US for USA and CA for Canada.

      • zip string- Valid US or Canada zip code for the E911 address to be added to your account. For example, 98104 for the US and M4C 5K7 for Canada.

Response Fields

On success, the HTTP status code in the response header is 201 Created and the response body contains an e911 object in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

If the address provided requires correction, then the response body will contain a list of errors, each with an object that contains the title Address Correction Required and a corrected address in the detail section.

Example Request

POST /v2/e911s HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "e911",
    "attributes": {
      "label": "Law Office",
      "first_name": "Bob",
      "last_name": "Law",
      "street_number": "123",
      "street_name": "Smith St",
      "address_type": "Suite",
      "address_type_number": "601",
      "city": "Seattle",
      "state": "WA",
      "country": "US",
      "zip": "98101"
    }
  }
}

Example Request

curl -X POST https://api.flowroute.com/v2/e911s -u accessKey:secretKey -d '{"data":{"type": "e911", "attributes":{"label": "First e911 record", "first_name": "Bob", "last_name": "Law", "street_number": "123", "street_name": "Smith St", "address_type": "Suite", "address_type_number": "601", "city": "Seattle", "state": "WA", "country": "US", "zip": "98101"}}}' -H 'Content-Type':'application/vnd+api.json'

Example Responses

Successful create and validate

201 Created

{
  "data": {
    "attributes": {
      "address_type": "Suite",
      "address_type_number": "601",
      "city": "Seattle",
      "country": "US",
      "first_name": "Bob",
      "label": "First e911 record",
      "last_name": "Law",
      "state": "WA",
      "street_name": "Smith St",
      "street_number": "123",
      "zip": "98101"
    },
    "id": "20217",
    "links": {
      "self": "https://api.flowroute.com/v2/e911s/20217"
    },
    "type": "e911"
  }
}

Duplicate E911

422 UNPROCESSABLE ENTITY

{
    "errors": [
        {
            "detail": "Duplicate e911 address found on your account.",
            "id": "d8cc519f-6640-42f0-9feb-768775c85d96",
            "status": 400,
            "title": "Client Error"
        }
    ]
}

Address Correction Required

The submitted address is 4th Avenue S and the corrected address is 4th Ave.

In this instance, even though your Postal Address may be 4th Avenue S, the PSAP requires it to be stored as 4th Ave. You will need to resubmit the request with the corrected address

E911 Request


curl -X POST
        -u TECHPREFIX:APISECRETKEY
        -H "Content-Type: application/json"
        "https://api.flowroute.com/v2/e911s/validate"
        -d '{
        "data": {
                "type": "e911",
                "attributes": {
                    "label": "First",
                    "first_name": "Bob",
                    "last_name": "Smith",
                    "street_number": "2101",
                    "street_name": "4th Avenue S",
                    "city": "Seattle",
                    "state": "WA",
                    "zip": "98121",
                    "country": "US"
                }
            }
        }

422 UNPROCESSABLE ENTITY

{
    "errors": [
        {
            "detail":{
                "city":"SEATTLE",
                "country":"US",
                "first_name":"Bob",
                "label":"First",
                "last_name":"Smith",
                "state":"WA",
                "street_name":"4TH AVE",
                "street_number":"2101",
                "zip":"98121"
            },
            "id":"1c5b6a81-1f5d-4c77-a23a-7e273b731c12",
            "status":422,
            "title":"Address Correction Required"
        },
        {
            "detail":{
                "city":"SEATTLE",
                "country":"US",
                "first_name":"Bob",
                "label":"First",
                "last_name":"Smith",
                "state":"WA",
                "street_name":"4TH AVE SOUTH",
                "street_number":"2101",
                "zip":"98121"
            },
            "id":"1c5b6a81-1f5d-4c77-a23a-7e273b731c12",
            "status":422,
            "title":"Address Correction Required"
        }
    ]
}