Create a related party

post

https://api.firmcheck.com/organisations/{organisationId}/related-parties

Add a related party to this organisation. The existing arm links one Firmcheck already holds; the other arms create a new individual or organisation.

Path Params

organisationId

string

required

The unique identifier for the organisation.

Body Params

Body

Create a new individual and add them as a related party.

object

string

enum

required

Allowed:

firstName

string

required

The first name of the individual.

middleName

string

The middle name of the individual.

lastName

string

required

The last name of the individual.

string

The email address of the individual.

residentialAddress

object

The residential address of the individual.

birth

object

The birth date of the individual. If provided, all fields (day, month, year) must be specified.

roles

array of strings

Defaults to []

The roles of this related party in the parent organisation.

roles

Headers

accept-version

string

enum

required

Allowed:

Responses

404

409

500

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Related party created successfully