ContractContacts
Get one ContractContact
Retrieve a single ContractContact record by its Id.
GET
Get one ContractContact
A ContractContact is a key contact entry on a virtual office contract (
CoworkerContract). Contacts can be directors, company aliases, or nominated recipients, and are used to identify, validate, and handle mail and deliveries addressed to anyone connected to a virtual office contract.
Each entry can be linked to an existing coworker via CoworkerId, in which case the coworker’s name and email are resolved automatically. Alternatively, provide FullName and Email directly for contacts who do not have a coworker record.
Use ContractContactType to classify the contact:
| Type | Description |
|---|---|
Director | A director of the company registered under the virtual office contract |
CompanyAlias | A trading name or alias used by the company |
NominatedRecipient | A person authorised to receive mail and deliveries on behalf of the company |
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ContractContact-Read role.Path Parameters
The Id of the ContractContact record to retrieve.
Code Examples
Response
200
ID of the coworker contract linked to this record.
The coworker contract quantity value for this contract contact.
The coworker contract floor plan desk ids value for this contract contact.
The coworker contract floor plan desk names value for this contract contact.
Plan name of the associated virtual office contract.
ID of the coworker linked to this record.
Full name of the linked coworker.
Company name of the linked coworker.
Billing name of the linked coworker.
Email address of the linked coworker.
Whether coworker active is enabled.
Email address of the contact. Used when the contact is not linked to a coworker record.
Full name of the contact. Used when the contact is not linked to a coworker record.
Date of birth. Used for identity verification purposes.
Street address.
Post code.
City name.
State or province.
ID of the country linked to this record.
Country name.
Phone number.
Optional notes or comments about this contract contact.
Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company). See
eContractContactType enum values: 0 = None, 1 = Director, 2 = CompanyAlias, 3 = NominatedRecipient.The AML check status for this contact. See
eAmlCheckStatus enum values: 0 = NotStarted, 1 = Pending, 2 = Clear, 3 = PotentialMatch, 4 = ConfirmedMatch, 5 = Error, 6 = ManuallyCleared.The date when the AML check was performed.
The score from the open sanctions check.
The response from the open sanctions check as JSON string.
The response from the Pappers AML check as TEXT string.
The status from the Pappers AML check.
Notes related to the AML check. Customers cannot see this field, it’s for internal use only.
The user who cleared the AML check.
The date when the AML check was cleared.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response
Get one ContractContact