Create ContractContact

POST

api

billing

contractcontacts

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/contractcontacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerContractId": 123,
  "FullName": "<string>",
  "ContractContactType": 123,
  "AmlCheckStatus": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/contractcontacts"

payload = {
    "CoworkerContractId": 123,
    "FullName": "<string>",
    "ContractContactType": 123,
    "AmlCheckStatus": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CoworkerContractId: 123,
    FullName: '<string>',
    ContractContactType: 123,
    AmlCheckStatus: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/contractcontacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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-Create role.

Enums

eContractContactType — ContractContactType values

Value	Name
0	None
1	Director
2	CompanyAlias
3	NominatedRecipient

eAmlCheckStatus — AmlCheckStatus values

Value	Name
0	NotStarted
1	Pending
2	Clear
3	PotentialMatch
4	ConfirmedMatch
5	Error
6	ManuallyCleared

Request Body

Required Fields

integer

required

ID of the coworker contract linked to this record.

string

required

Full name of the contact. Used when the contact is not linked to a coworker record.

integer

required

Role of this contact: Director (a company director), CompanyAlias (a trading name), or NominatedRecipient (authorised to receive mail on behalf of the company). Defaults to eContractContactType.Director.

integer

required

The AML check status for this contact.

Optional Fields

integer

ID of the coworker linked to this record.

string

Email address of the contact. Used when the contact is not linked to a coworker record.

string

Date of birth. Used for identity verification purposes.

string

Street address.

string

Post code.

string

City name.

string

State or province.

integer

ID of the country linked to this record.

string

Phone number.

string

Optional notes or comments about this contract contact.

string

The date when the AML check was performed.

number

The score from the open sanctions check.

string

The response from the open sanctions check as JSON string.

string

The response from the Pappers AML check as TEXT string.

string

The status from the Pappers AML check.

string

Notes related to the AML check. Customers cannot see this field, it’s for internal use only.

string

The user who cleared the AML check.

string

The date when the AML check was cleared.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/contractcontacts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerContractId": 0,
    "FullName": "",
    "ContractContactType": 0,
    "AmlCheckStatus": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/contractcontacts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerContractId: 0,
      FullName: '',
      ContractContactType: 0,
      AmlCheckStatus: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/contractcontacts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerContractId': 0,
        'FullName': '',
        'ContractContactType': 0,
        'AmlCheckStatus': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the contractcontact was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ContractContact was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "FullName: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "FullName"
    }
  ],
  "WasSuccessful": false
}

Update ContractContactUpdate an existing ContractContact record.

Create ContractContact

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/contractcontacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerContractId": 123,
  "FullName": "<string>",
  "ContractContactType": 123,
  "AmlCheckStatus": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/contractcontacts"

payload = {
    "CoworkerContractId": 123,
    "FullName": "<string>",
    "ContractContactType": 123,
    "AmlCheckStatus": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    CoworkerContractId: 123,
    FullName: '<string>',
    ContractContactType: 123,
    AmlCheckStatus: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/contractcontacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400