Add Contact

Create one or more contact records for an existing customer account. This endpoint allows you to add authorized individuals or company representatives who can: - Manage the customer's account - Receive account updates and notifications - Execute trades on behalf of the customer Use this when a customer needs additional people with account access permissions. **Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customerIdstringRequired

The unique identifier you received from the Get Customer’s ID API response.

Request

This endpoint expects a list of objects.
first_namestringRequired
First name of this contact person
last_namestringRequired
Last name of this contact person
date_of_birthstringRequiredformat: "date"

DOB of contact person in ISO 8601 format (YYYY-MM-DD)

emailstringRequiredformat: "email"
Email address of the contact person
mobile_numberstringRequired

Contact mobile number in E.164 international format (e.g., +14155552671).

primary_contactbooleanRequired
Primary contact for the customer account
authorize_to_tradebooleanRequired
Whether the customer is authorised to trade with us
addressobjectRequired
middle_namestringOptional
Middle name of this contact person
employment_statusstringOptional

Employment status of the contact. See Employment Status API for a list of supported values.

industrystringOptional

Employment industry of the contact. See Employment Industry API for a list of supported values.

nationalitystringOptional
Nationality of the contact
phone_numberstringOptional
Contact phone number
proof_of_identityobjectOptional
Supporting identification documents for the contact. Provide exactly one document type per contact.

Response

Created. Contact added successfully.
customer_idstring or null
Identifier of the customer this contact belongs to.

Errors