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: |
firstName | String | Read only |
The first name of the person. This field is present only when |
lastName | String | Read only |
The last name of the person. This field is present only when |
name | String | Read only |
The name of the organisation. This field is present only when |
pictureURL | String | Read only |
A 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. |