Restricted Party Model

Represents information about a party that has been made restricted in Capsule for the user calling the API endpoint.

Name Type Description
id Long Read only

The unique id of the restricted party

type String Read only

Represents if this party is a person or an organisation

Accepted values are: person, organisation

firstName String Read only

First name of the person. This field is present only when type is person. This will be null due to the person being made restricted.

lastName String Read only

Last name of the person. This field is present only when type is person. This will be Private due to the person being made restricted.

name String Read only

The name of the organization. This field is present only when type is organisation. This will be Private due to the organisation being made restricted.

pictureURL String Read only

An url that represents the location of the profile picture for this party. This field is automatically derived by Capsule and cannot be edited.

isRestricted Boolean Read only

Defines whether this party is restricted for the user calling the API endpoint