Skip to content

Overview (1.0)

Overview

Terms of Service

Languages
Servers

https://api.kycaid.com/

Addresses

Addresses

Operations

Affiliated persons

Affiliated persons

Operations

Create an affiliated person

Request

Create and add an affiliated person for an applicant object

Security
your_api_key
Bodyapplication/json
One of:
typestringrequired
Value"AUTHORISED"
applicant_idstring= 36 charactersrequired
first_namestring or null(name)[ 2 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$required
last_namestring or null(name)[ 2 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$required
titlestring or null[ 1 .. 36 ] charactersrequired
dobstring or null(date)required
residence_countrystring or null= 2 charactersrequired
nationalitystring or null= 2 charactersrequired
emailstring or null(email)[ 1 .. 254 ] charactersrequired
application/json
{
  "type": "AUTHORISED",
  "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7",
  "first_name": "Josh",
  "last_name": "Coffey",
  "title": "CDO",
  "dob": "1976-02-21",
  "residence_country": "GB",
  "nationality": "GB",
  "email": "josh.coffey@example.com"
}

Responses

OK

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

Bodyapplication/json
affiliated_person_idstring= 36 characters
Response
application/json
{
  "affiliated_person_id": "74cec9e50f844748be0bc321a2bf66638f54"
}

Update an affiliated person

Request

Update records of an affiliated person object in our system

Security
your_api_key
Path
affiliated_person_idstring= 36 charactersrequired

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

Example: 74cec9e50f844748be0bc321a2bf66638f54
Bodyapplication/json
first_namestring or null(name)[ 2 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$
last_namestring or null(name)[ 2 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$
titlestring or null[ 1 .. 36 ] characters
sharenumber or null(float)[ 0 .. 100 ]
dobstring or null(date)
residence_countrystring or null= 2 characters
nationalitystring or null= 2 characters
emailstring or null(email)[ 1 .. 254 ] characters
application/json
{
  "first_name": "Josh",
  "last_name": "Coffey",
  "title": "CDO",
  "share": 13.05,
  "dob": "1976-02-21",
  "residence_country": "GB",
  "nationality": "GB",
  "email": "josh.coffey@example.com"
}

Responses

OK

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

Bodyapplication/json
affiliated_person_idstring= 36 characters
Response
application/json
{
  "affiliated_person_id": "74cec9e50f844748be0bc321a2bf66638f54"
}

Delete an affiliated person

Request

Delete records of an affiliated person object from our system

Security
your_api_key
Path
affiliated_person_idstring= 36 charactersrequired

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

Example: 74cec9e50f844748be0bc321a2bf66638f54
No request payload

Responses

OK

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

Bodyapplication/json
affiliated_person_idstring= 36 characters
Response
application/json
{
  "affiliated_person_id": "74cec9e50f844748be0bc321a2bf66638f54"
}

Applicants

Applicants

Operations

Documents

Documents

Operations

Files

Files

Operations

Forms

Forms

Operations

Verifications

Verifications

Operations