Create an address

Addresses

Operations

Create an address

Request

Create and add an address object to an applicant or an affiliated person. Only one address per type may be added to an object

Security

API-Key

Bodyapplication/json

One of:

applicant_idstring= 36 charactersrequired

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

typestringrequired

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

REGISTERED for the residential address of a person
ADDITIONAL for any other address associated with a person

Enum"REGISTERED""ADDITIONAL"

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

countrystring or null= 2 characters

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

statestring or null[ 1 .. 50 ] characters

A state of a person or a company

regionstring or null[ 1 .. 50 ] characters

A region of a country of an object

provincestring or null[ 1 .. 50 ] characters

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

citystring or null[ 1 .. 50 ] characters

A city or a town of a person or a company

districtstring or null[ 1 .. 50 ] characters

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

addressstring or null[ 1 .. 50 ] characters

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

postal_codestring or null[ 1 .. 20 ] characters

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

street_namestring or null[ 1 .. 50 ] characters

A street name of an object

building_numberstring or null[ 1 .. 20 ] characters

A number of a building of an object

unit_numberstring or null[ 1 .. 20 ] characters

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

application/json

{
  "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7",
  "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

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

Response

application/json

{
  "address_id": "723f46ab04feb64f442946f2953a67eaecf7"
}

Update an 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: 723f46ab04feb64f442946f2953a67eaecf7

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"

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

countrystring or null= 2 characters

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

statestring or null[ 1 .. 50 ] characters

A state of a person or a company

regionstring or null[ 1 .. 50 ] characters

A region of a country of an object

provincestring or null[ 1 .. 50 ] characters

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

citystring or null[ 1 .. 50 ] characters

A city or a town of a person or a company

districtstring or null[ 1 .. 50 ] characters

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

addressstring or null[ 1 .. 50 ] characters

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

postal_codestring or null[ 1 .. 20 ] characters

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

street_namestring or null[ 1 .. 50 ] characters

A street name of an object

building_numberstring or null[ 1 .. 20 ] characters

A number of a building of an object

unit_numberstring or null[ 1 .. 20 ] characters

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

application/json

{
  "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

Response

application/json

{
  "address_id": "723f46ab04feb64f442946f2953a67eaecf7"
}

Delete an address

Request

Deletes an address object from our system

Please note, that addresses may be deleted only before a verification was created

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: 723f46ab04feb64f442946f2953a67eaecf7

No request payload

Responses

OK

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

Bodyapplication/json

address_idstring= 36 characters

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

Response

application/json

{
  "address_id": "723f46ab04feb64f442946f2953a67eaecf7"
}

Affiliated persons

Operations

Applicants

Operations

Documents

Operations

Files

Operations

Forms

Operations

Verifications

Operations

Overview (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Addresses