Skip to main content

Address API

The Address API is used for validating and querying addresses, as well as getting suggestions in scenarios where the complete address is not known. It currently supports Norwegian addresses (street, place, post office box and postal place addresses). Addresses validated by this API are guaranteed to be valid, and it is therefore recommended to validate addresses that are used as input to Booking and Checkout related APIs.

Authentication

To make API requests, you will need an API key from Mybring. Steps for getting a key and description of headers can be found on the general API Getting Started / Authentication page.

Rate limiting

Clients exceeding 40 requests per second will be throttled, and the response will contain http status code 429. If you have a use case requiring rates above the limit, please contact developer-booking@bring.com for assistance.

Formats

REST XML/JSON over HTTP.

Returned format is controlled by the Accept header. Supported values are application/json and application/xml. Default returned format is JSON.

Endpoints

Base URL
https://api.bring.com/address/
Usage Method Endpoint
Get addresses matching query GET /api/{country-code}/addresses
Get address GET /api/{country-code}/addresses/{id}
Get street GET /api/{country-code}/streets/{id}
Get available street numbers GET /api/{country-code}/streets/{id}/numbers
Get street or place suggestions GET /api/{country-code}/suggestions
Validate provided address GET /api/{country-code}/validation

Get addresses matching query

get
                            https://api.bring.com/address/api/{country-code}/addresses
                          

Fetches addresses matching provided filters.

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

path parameters

country-code
Required
Description
Country code
Type
string
Value
no

query parameters

street_or_place
Description
Street or place name. Required when querying for street and place address types
Type
string
Example
street_or_place=kolåsveien
address_type
Required
Description
Address type
Type
string
Enum
street
place
postal_place
po_box
po_box_number
Description
Post office box number
Type
integer
Example
po_box_number=1
po_box_facility
Description
Post office box facility name
Type
string
Example
po_box_facility=Sentrum
postal_code
Description
Postal code
Type
string
Example
postal_code=1555
city
Description
City
Type
string
Example
city=Son
street_number
Description
Street number
Type
integer
Example
street_number=9
letter
Description
House letter
Type
string
Example
letter=B
page
Description
Page number for paginated results
Type
integer
limit
Description
Number of results per page. Default 10. Max 10.
Type
integer

Responses

200 OK

Schema

Required
array of objects
address_id
Unique address id
string
city
City
string
Coordinate
object
latitude
WGS84 Latitude
string
longitude
WGS84 Longitude
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
object
Required
array wrapped
Alternate address suggestions
object
AddressId
Unique address id
string
City
City
string
Coordinate
object
Latitude
WGS84 Latitude
string
Longitude
WGS84 Longitude
string
County
County address is located in
string
HouseNumber
House number
integer <int32>
Letter
House letter
string
Municipality
Municipality address is located in
string
Place
Place name
string
PostOfficeBoxFacility
Post office box facility name
string
PostOfficeBoxNumber
Post office box number
integer <int32>
PostalCode
Postal code
string
StreetName
Street name
string
Type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
first
First page
string attribute
last
Last page
string attribute
next
Next page
string attribute
prev
Previous page
string attribute
self
Link to self
string attribute
totalHits
Total number of hits
integer <int32> attribute
204 Address not found
400 Bad Request

Schema

array of objects
code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
array
object
Code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
Description
string
429 Too Many Requests

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
500 Internal Server Error

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string

Response examples

{
  "addresses": [
    {
      "address_id": "1817301",
      "city": "Son",
      "coordinate": {
        "latitude": "60.0000",
        "longitude": "5.0000"
      },
      "county": "Viken",
      "house_number": 9,
      "municipality": "Vestby",
      "postal_code": "1555",
      "street_name": "Kolåsveien",
      "type": "STREET"
    },
    {
      "address_id": "1817302",
      "city": "Son",
      "coordinate": {
        "latitude": "60.0000",
        "longitude": "5.0000"
      },
      "county": "Viken",
      "house_number": 10,
      "municipality": "Vestby",
      "postal_code": "1555",
      "street_name": "Kolåsveien",
      "type": "STREET"
    }
  ],
  "navigation": {
    "self": "https://api.bring.com/address/api/no/addresses?street_or_place=kol%C3%A5sveien&address_type=street&postal_code=1555&city=Son&page=1",
    "total_hits": 2
  }
}

Get address

get
                            https://api.bring.com/address/api/{country-code}/addresses/{id}
                          

Fetches details for provided address id

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
any
X-Mybring-API-Key
Required
Description
Your user's API key
Type
any
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

path parameters

country-code
Required
Description
Country code
Type
string
Value
no
id
Required
Description
Id of address to fetch
Type
any
Example
2264429

Responses

200 OK

Schema

address_id
Unique address id
string
city
City
string
Coordinate
object
latitude
WGS84 Latitude
string
longitude
WGS84 Longitude
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
Alternate address suggestions
object
AddressId
Unique address id
string
City
City
string
Coordinate
object
Latitude
WGS84 Latitude
string
Longitude
WGS84 Longitude
string
County
County address is located in
string
HouseNumber
House number
integer <int32>
Letter
House letter
string
Municipality
Municipality address is located in
string
Place
Place name
string
PostOfficeBoxFacility
Post office box facility name
string
PostOfficeBoxNumber
Post office box number
integer <int32>
PostalCode
Postal code
string
StreetName
Street name
string
Type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
400 Bad Request

Schema

array of objects
code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
array
object
Code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
Description
string
404 Address not found

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
429 Too Many Requests

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
500 Internal Server Error

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string

Response examples

{
  "address_id": "3419922",
  "city": "Sulitjelma",
  "coordinate": {
    "latitude": "60.0000",
    "longitude": "5.0000"
  },
  "county": "Nordland",
  "municipality": "Fauske",
  "place": "Stormo",
  "postal_code": "8230",
  "type": "PLACE"
}

Get street

get
                            https://api.bring.com/address/api/{country-code}/streets/{id}
                          

Fetches details for provided street id

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

path parameters

country-code
Required
Description
Country code
Type
string
Value
no
id
Required
Description
Id of street to fetch
Type
string
Example
NO-0301-11704

Responses

200 OK

Schema

city
string
county
string
id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
name
Street or place name
string
postal_code
string
type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
City
string
County
string
Id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
Name
Street or place name
string
PostalCode
string
Type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
400 Bad Request

Schema

array of objects
code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
array
object
Code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
Description
string
404 Street not found

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
429 Too Many Requests

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
500 Internal Server Error

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string

Response examples

{
  "city": "Sulitjelma",
  "county": "Nordland",
  "id": "3419922",
  "name": "Stormo",
  "postal_code": "8230",
  "type": "PLACE"
}

Get available street numbers

get
                            https://api.bring.com/address/api/{country-code}/streets/{id}/numbers
                          

Returns a list of available street numbers for provided street id.

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

path parameters

country-code
Required
Description
Country code
Type
string
Value
no
id
Required
Description
Street id
Type
string
Example
NO-3019-04900

query parameters

page
Description
Page number for paginated results
Type
integer
limit
Description
Number of results per page. Default 20. Max 20.
Type
integer

Responses

200 OK

Schema

object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
street_name
Street name
string
Required
array of objects
address_id
Unique address id
string
formatted_number
House number (and letter) combined
string
letter
House letter
string
number
House number
integer <int32>
object
object
first
First page
string attribute
last
Last page
string attribute
next
Next page
string attribute
prev
Previous page
string attribute
self
Link to self
string attribute
totalHits
Total number of hits
integer <int32> attribute
StreetName
Street name
string
Required
array wrapped
object
AddressId
Unique address id
string
FormattedNumber
House number (and letter) combined
string
Letter
House letter
string
Number
House number
integer <int32>
400 Bad Request

Schema

array of objects
code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
array
object
Code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
Description
string
404 Not Found

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
429 Too Many Requests

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
500 Internal Server Error

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string

Response examples

{
  "navigation": {
    "self": "https://api.bring.com/address/api/no/streets/NO-3019-04900/numbers&page=1",
    "total_hits": 4
  },
  "street_name": "Kolåsveien",
  "street_numbers": [
    {
      "address_id": "1817301",
      "formatted_number": "1",
      "number": 1
    },
    {
      "address_id": "1817302",
      "formatted_number": "1A",
      "letter": "A",
      "number": 1
    },
    {
      "address_id": "1817303",
      "formatted_number": "1B",
      "letter": "B",
      "number": 1
    },
    {
      "address_id": "1817304",
      "formatted_number": "2",
      "number": 2
    }
  ]
}

Get street or place suggestions

get
                            https://api.bring.com/address/api/{country-code}/suggestions
                          

Returns a list of streets and places matching input query. The following address types are supported: - Street address - Place Depending on the returned suggestion type, the id will differ. Returned suggestions are identified by either an street_id or an address_id. Suggestions of type STREET are identified with street_id which is an unique identifier for a street. To obtain an address_id you will need street number as well. Suggestions of type PLACE are identified with address_id, which are unique addresses and does not support street numbers.

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

path parameters

country-code
Required
Description
Country code
Type
string
Value
no

query parameters

q
Required
Description
Street or place name to filter for
Type
string
Examples
Partial street or place name
Will return all matching streets or places containing this nameq=kolås
Street or place name
Will return all matching streets or places with this nameq=kolåsveien
Street or place name with city
If city is known you may supply it (prefixed by ,) to narrow the searchq=kolås, son
Street or place name with postal code
If postal code is known you may supply it (prefixed by ,) to narrow the searchq=kolås, 1555
page
Description
Page number for paginated results
Type
integer
limit
Description
Number of results per page. Default 10. Max 10.
Type
integer

Responses

200 OK

Schema

object
first
First page
string
last
Last page
string
next
Next page
string
prev
Previous page
string
self
Link to self
string
total_hits
Total number of hits
integer <int32>
Required
array of objects
city
string
county
string
id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
name
Street or place name
string
postal_code
string
type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
object
object
first
First page
string attribute
last
Last page
string attribute
next
Next page
string attribute
prev
Previous page
string attribute
self
Link to self
string attribute
totalHits
Total number of hits
integer <int32> attribute
Required
array wrapped
object
City
string
County
string
Id
Street or address id. For addresses of type STREET, this will contain the street id. For other address types address id is returned.
string
Name
Street or place name
string
PostalCode
string
Type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
400 Bad Request

Schema

array of objects
code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
array
object
Code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
Description
string
429 Too Many Requests

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
500 Internal Server Error

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string

Response examples

{
  "navigation": {
    "self": "https://api.bring.com/address/api/no/suggestions?page=1",
    "total_hits": 2
  },
  "streets_and_places": [
    {
      "city": "Oslo",
      "county": "Oslo",
      "id": "NO-0301-11704",
      "name": "Falsens gate",
      "postal_code": "0556",
      "type": "STREET"
    },
    {
      "city": "Sulitjelma",
      "county": "Nordland",
      "id": "3419922",
      "name": "Stormo",
      "postal_code": "8230",
      "type": "PLACE"
    }
  ]
}

Validate provided address

get
                            https://api.bring.com/address/api/{country-code}/validation
                          

Will attempt to find a matching address. If no exact match is found, a list of possible reasons are returned along with close matching alternative suggestions (if found).

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

path parameters

country-code
Required
Description
Country code
Type
string
Value
no

query parameters

street_or_place
Description
Street or place name. Required when querying for street and place address types
Type
string
Example
street_or_place=kolåsveien
address_type
Required
Description
Address type
Type
string
Enum
street
place
postal_place
po_box
po_box_number
Description
Post office box number
Type
integer
Example
po_box_number=1
po_box_facility
Description
Post office box facility name
Type
string
Example
po_box_facility=Sentrum
postal_code
Required
Description
Postal code
Type
string
Example
postal_code=1555
city
Description
City. Required for postal place addresses
Type
string
Example
city=Son
street_number
Description
Street number. Required for street addresses
Type
integer
Example
street_number=9
letter
Description
House letter
Type
string
Example
letter=B

Responses

200 OK

Schema

Alternate address suggestions
object
address_id
Unique address id
string
city
City
string
Coordinate
object
latitude
WGS84 Latitude
string
longitude
WGS84 Longitude
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
Possible reasons why provided address was not found
array of objects
code
Validation error code
string
Enum
HOUSE_NUMBER_DOES_NOT_EXIST
HOUSE_LETTER_DOES_NOT_EXIST
STREET_NAME_DOES_NOT_EXIST
PLACE_DOES_NOT_EXIST
ADDRESS_NOT_FOUND
INCORRECT_CITY
PO_BOX_NUMBER_DOES_NOT_EXIST
PO_BOX_FACILITY_DOES_NOT_EXIST
description
Validation error description
string
Alternate address suggestions
array of objects
address_id
Unique address id
string
city
City
string
Coordinate
object
latitude
WGS84 Latitude
string
longitude
WGS84 Longitude
string
county
County address is located in
string
house_number
House number
integer <int32>
letter
House letter
string
municipality
Municipality address is located in
string
place
Place name
string
po_box_facility
Post office box facility name
string
po_box_number
Post office box number
integer <int32>
postal_code
Postal code
string
street_name
Street name
string
type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
valid
Required
Address is valid
boolean
object
Alternate address suggestions
object
AddressId
Unique address id
string
City
City
string
Coordinate
object
Latitude
WGS84 Latitude
string
Longitude
WGS84 Longitude
string
County
County address is located in
string
HouseNumber
House number
integer <int32>
Letter
House letter
string
Municipality
Municipality address is located in
string
Place
Place name
string
PostOfficeBoxFacility
Post office box facility name
string
PostOfficeBoxNumber
Post office box number
integer <int32>
PostalCode
Postal code
string
StreetName
Street name
string
Type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
Possible reasons why provided address was not found
array wrapped
Possible reasons why provided address was not found
object
Code
Validation error code
string
Enum
HOUSE_NUMBER_DOES_NOT_EXIST
HOUSE_LETTER_DOES_NOT_EXIST
STREET_NAME_DOES_NOT_EXIST
PLACE_DOES_NOT_EXIST
ADDRESS_NOT_FOUND
INCORRECT_CITY
PO_BOX_NUMBER_DOES_NOT_EXIST
PO_BOX_FACILITY_DOES_NOT_EXIST
Description
Validation error description
string
Alternate address suggestions
array wrapped
Alternate address suggestions
object
AddressId
Unique address id
string
City
City
string
Coordinate
object
Latitude
WGS84 Latitude
string
Longitude
WGS84 Longitude
string
County
County address is located in
string
HouseNumber
House number
integer <int32>
Letter
House letter
string
Municipality
Municipality address is located in
string
Place
Place name
string
PostOfficeBoxFacility
Post office box facility name
string
PostOfficeBoxNumber
Post office box number
integer <int32>
PostalCode
Postal code
string
StreetName
Street name
string
Type
Address type
string
Enum
STREET
PLACE
POSTAL_PLACE
PO_BOX
Valid
Required
Address is valid
boolean
400 Bad Request

Schema

array of objects
code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
description
string
array
object
Code
string
Enum
INVALID_COUNTRY
QUERY_PARAM_MISSING_OR_EMPTY
QUERY_PARAM_EMPTY
INVALID_PAGE_NUMBER
INVALID_LIMIT
LIMIT_LARGER_THAN_5
LIMIT_LARGER_THAN_10
LIMIT_LARGER_THAN_20
INVALID_POSTAL_CODE
MISSING_ADDRESS_TYPE
INVALID_ADDRESS_TYPE
MISSING_STREET_OR_PLACE
MISSING_POSTAL_CODE_OR_CITY_POSTAL_PLACE_ADDRESS
MISSING_CITY_POSTAL_PLACE_ADDRESS
MISSING_OR_INVALID_POSTAL_CODE
INVALID_STREET_NUMBER
INVALID_PO_BOX_NUMBER
INVALID_LETTER
NO_QUERY_PARAMS
MISSING_STREET_NUMBER
MISSING_PO_BOX_NUMBER
Description
string
429 Too Many Requests

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string
500 Internal Server Error

Schema

code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
description
string
object
Code
string
Enum
INTERNAL_ERROR
NOT_FOUND
RATE_LIMIT_EXCEEDED
Description
string

Response examples

{
  "reasons": [
    {
      "code": "ADDRESS_NOT_FOUND",
      "description": "No matching address found, and no alternative suggestions available"
    }
  ],
  "valid": false
}
comments powered by Disqus