Skip to content

Update address

Request

Update records of an address object in our system

In case when an address becomes a part of a created verification, then our system will create a copy of an address object and will provide you with a different address_id in a response

Security
API-Key
Path
address_idstring, = 36 charactersrequired

A unique identifier of an address object, that is assigned by our system after an address entity was created

Example:27c5caea93ee4656881ef9a30fadd21a3768
Bodyapplication/json
typestring

A type of an address object. The possible types are:

  • REGISTERED for the residential address of a person or an affiliated person, or the registered address of a company
  • BUSINESS for the primary business location of a company
  • ADDITIONAL for any other address associated with a person, an affiliated person, or a company
Enum:"REGISTERED""BUSINESS""ADDITIONAL"
Example:"REGISTERED"
full_addressstring or null, [ 1 .. 255 ] characters

A full address of an object, including a street address, a unit, a city, a postal code, a country

Example:"45 High Street, Flat 2A, London, SW1A 1AA, United Kingdom"
countrystring or null, = 2 characters

A country of an object. A two-letter country code according to ISO 3166-2

Example:"GB"
statestring or null, [ 1 .. 50 ] characters

A state of a person or a company

Example:null
regionstring or null, [ 1 .. 50 ] characters

A region of a country of an object

Example:"Scotland"
provincestring or null, [ 1 .. 50 ] characters

A province (a sub-region of a country) of an object

Example:"Ontario"
citystring or null, [ 1 .. 50 ] characters

A city or a town of a person or a company

Example:"London"
districtstring or null, [ 1 .. 50 ] characters

The district (an area of a city) of an object

Example:"Westminster"
addressstring or null, [ 1 .. 50 ] characters

An address (a street name, a building number, and a unit number) of a person or a company

Example:"45 High Street, Flat 2A"
postal_codestring or null, [ 1 .. 20 ] characters

A postal code (zip code, postcode) of a person or a company

Example:"SW1A 1AA"
street_namestring or null, [ 1 .. 50 ] characters

A street name of an object

Example:"High Street"
building_numberstring or null, [ 1 .. 20 ] characters

A number of a building of an object

Example:"45"
unit_numberstring or null, [ 1 .. 20 ] characters

A number of a unit (flat, apartment) of an object

Example:"Flat 2A"
{
  "type": "REGISTERED",
  "full_address": "45 High Street, Flat 2A, London, SW1A 1AA, United Kingdom",
  "country": "GB",
  "state": null,
  "region": "Scotland",
  "province": "Ontario",
  "city": "London",
  "district": "Westminster",
  "address": "45 High Street, Flat 2A",
  "postal_code": "SW1A 1AA",
  "street_name": "High Street",
  "building_number": "45",
  "unit_number": "Flat 2A"
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
address_idstring, = 36 characters

In case when an address becomes a part of a created verification, then our system will create a copy of an address object and provide you with a different address_id in a response

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
Response
{
  "address_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}