Skip to content
Languages
Servers

https://api.kycaid.com/

Operations

Affiliated persons

Affiliated persons

Operations

Request

Create and add an affiliated person for an applicant object

Security
Your API key
Bodyapplication/json
One of:
typestringrequired

A type of an affiliated person object. AUTHORISED type is used for adding an authorised affiliated person object

Value"AUTHORISED"
applicant_idstring(uuid)= 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

first_namestring or null(name)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$required

A first name of an object

last_namestring or null(name)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$required

A last name of an object

titlestring or null[ 1 .. 36 ] charactersrequired

A title of an authorised affiliated person object in a company

dobstring or null(date)required

The date of birth of a person, formatted according to ISO 8601

residence_countrystring or null= 2 charactersrequired

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

nationalitystring or null= 2 charactersrequired

A nationality country of a person. A two-letter country code according to ISO 3166-2

emailstring or null(email)[ 1 .. 254 ] charactersrequired

An email address of an object

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(uuid)= 36 characters

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

Response
application/json
{ "affiliated_person_id": "74cec9e50f844748be0bc321a2bf66638f54" }

Request

Update records of an affiliated person object in our system

Security
Your API key
Path
affiliated_person_idstring(uuid)= 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)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$

A first name of an object

last_namestring or null(name)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$

A last name of an object

titlestring or null[ 1 .. 36 ] characters

A title of an authorised affiliated person object in a company

sharenumber or null(float)[ 0 .. 100 ]

A share in percents of a beneficial affiliated person object in a company

dobstring or null(date)

The date of birth of a person, formatted according to ISO 8601

residence_countrystring or null= 2 characters

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

nationalitystring or null= 2 characters

A nationality country of a person. A two-letter country code according to ISO 3166-2

emailstring or null(email)[ 1 .. 254 ] characters

An email address of an object

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(uuid)= 36 characters

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

Response
application/json
{ "affiliated_person_id": "74cec9e50f844748be0bc321a2bf66638f54" }

Request

Delete records of an affiliated person object from our system

Security
Your API key
Path
affiliated_person_idstring(uuid)= 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(uuid)= 36 characters

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

Response
application/json
{ "affiliated_person_id": "74cec9e50f844748be0bc321a2bf66638f54" }
Operations
Operations
Operations
Operations
Operations