Contacts

Professional contact attached to a company, used for collection, signing, and roles.

Business object

Vue d’ensemble

Contact endpoints maintain a contact's display name and contact details. Attachment to a company is mandatory; checks are separate `compliance_check` resources.

See also the business-model page contact for semantics, relationships, and functional lifecycle.

Contrat JSON

Objet contact

Responses use the prefixed identifier ctc_ and the field object to make the type explicit.

company_idstring

Identifier of the company to which the contact belongs.

merchant_idstring

Merchant identifier.

full_namestring

Canonical and required full name.

first_name / last_namestring

Optional structured components.

email / phonestring

Contact details.

job_title / preferred_localestring

Job title and preferred BCP 47 locale.

REST

Endpoints

MethodEndpointUsage
POST/v1/contactsCreate a contact.
GET/v1/contactsList contacts, with filters for `company_id`, `merchant_id`, or `source_reference`.
GET/v1/contacts/searchResolve a unique contact by email, optionally within a company.
GET/v1/contacts/{id}Retrieve a contact.
POST/v1/contacts/{id}Update professional profile and contact details.
POST/v1/contacts/{id}/suspendSuspend the contact without erasing history.
POST/v1/contacts/{id}/reactivateLift the contact suspension.

Events

Associated events

These events can be consumed through platform webhooks when the account is configured to receive them.

contact.createdcontact.updatedcontact.suspendedcontact.reactivated

Behavior

Points d’attention

  • Search returns `contact_search_result` with `contact` or null.
  • Listing by `source_reference` requires `merchant_id` to avoid ambiguous global search.
  • A suspended contact remains retrievable and editable but is no longer resolved and cannot receive a role.