Skip to content

Create affiliated person

Request

Create and add an affiliated person for an applicant object

Security
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"
Example:"AUTHORISED"
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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
first_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$required

The first name of a person

Example:"Josh"
last_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$required

The last name of a person

Example:"Coffey"
titlestring or null, [ 1 .. 36 ] charactersrequired

A title of an authorised affiliated person object in a company

Example:"CDO"
dobstring or null, (date)required

The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601

Example:"1976-02-21"
residence_countrystring or null, = 2 charactersrequired

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

Example:"GB"
nationalitystring or null, = 2 charactersrequired

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

Example:"GB"
emailstring or null, (email), [ 1 .. 254 ] charactersrequired

The email address of a person or a company

Example:"josh.coffey@example.com"
{
  "type": "AUTHORISED",
  "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "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

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:"27c5caea93ee4656881ef9a30fadd21a3768"
Response
{
  "affiliated_person_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}