Skip to content

Overview (1.0)

Download OpenAPI description
objects.json
objects.yaml
Overview
Terms of Service
Languages
Servers
https://api.kycaid.com/

Addresses

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
your_api_key
Bodyapplication/json
One of:
applicant_idstring= 36 charactersrequired
typestringrequired
Enum"REGISTERED""ADDITIONAL"
full_addressstring or null[ 1 .. 255 ] characters
countrystring or null= 2 characters
statestring or null[ 1 .. 50 ] characters
regionstring or null[ 1 .. 50 ] characters
provincestring or null[ 1 .. 50 ] characters
citystring or null[ 1 .. 50 ] characters
districtstring or null[ 1 .. 50 ] characters
addressstring or null[ 1 .. 50 ] characters
postal_codestring or null[ 1 .. 20 ] characters
street_namestring or null[ 1 .. 50 ] characters
building_numberstring or null[ 1 .. 20 ] characters
unit_numberstring or null[ 1 .. 20 ] characters
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
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
your_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
Enum"REGISTERED""BUSINESS""ADDITIONAL"
full_addressstring or null[ 1 .. 255 ] characters
countrystring or null= 2 characters
statestring or null[ 1 .. 50 ] characters
regionstring or null[ 1 .. 50 ] characters
provincestring or null[ 1 .. 50 ] characters
citystring or null[ 1 .. 50 ] characters
districtstring or null[ 1 .. 50 ] characters
addressstring or null[ 1 .. 50 ] characters
postal_codestring or null[ 1 .. 20 ] characters
street_namestring or null[ 1 .. 50 ] characters
building_numberstring or null[ 1 .. 20 ] characters
unit_numberstring or null[ 1 .. 20 ] characters
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
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
your_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
Response
application/json
{
  "address_id": "723f46ab04feb64f442946f2953a67eaecf7"
}

Affiliated persons

Affiliated persons

Operations

Applicants

Applicants

Operations

Documents

Documents

Operations

Files

Files

Operations

Forms

Forms

Operations

Verifications

Verifications

Operations