Removes association of one or more participants from the specified contact. When data segregation is enabled, applications of any of the specified participants may no longer access the specified contact. Note that any existing member association is not automatically revoked and required to be handled separately.

Associates one or more participants to the specified contact. When data segregation is enabled:

• Applications of a specific participant may only access contacts associated with their participant.
• Members of a specific participant may only be directly assigned to contacts associated with their participant.

The endpoint returns the profile(s) of the advisor(s) of the contact.

Returns the stored profile picture of the specified advisor of the contact

Assigns a member to a contact. The assigned member and all members with hierarchy access to that member would have access to all contact information.

Manages member assignment to a contact. The assigned members and all members with hierarchy access to them would have access to all contact information.

Searches for members assigned to the specified contacts. The assigned members and all members with hierarchy access to them have access to all contact information.

Retrieves change-request for details of the contact.

Enumerates change request statuses.

Checks if a pending change request exists. If yes retrieves basic information on it.

Searches change-requests given criteria. A member can only see change requests for contacts which they have access to (with or without hierarchy).

Cancels a change-request. Cancelling is only possible from “pending” status, and can be done only by the member which initiated the change-request.

Reviews a change-request. Review is only possible from "pending" status. Initiating member cannot review their own change.

Deletes the profile picture for the contact specified

Returns the stored profile picture for the contact specified

Updates and stores a profile picture for the contact specified

Retrieves all details saved on a contact.

Partially updates contact details:

• A contact may update only fields which are schema-configured to be update-able by a contact.
• A member may update any non-disabled field, but might be subject to an approval process if any of the fields updated requires approval (per schema configuration). Resulting change-request will need to be reviewed and approved for the changes to be applied.
• An app may update any non-disabled field.

Any update would be subject to the following:

• All schema-configured mandatory details should be present following the data update.
• Additional details outside of the contact data schema are not allowed to be passed.
• If DFS is configured to derive the username from the contact’s email, and email is passed in context of the call, the endpoint would require a valid and unique email from the user.
• Arrays must be passed in full. Partially updating arrays (adding or removing entries) is unsupported.
  
  

  Possible ApiError.SubCode values:
  
  UsernameNotUnique: The provided username or email (when username is coupled with email) is not unique.
  

Updates contact details in full. A member updating contact details might be subject to an approval process if any of the fields updated requires approval (per contact data schema configuration). The resulting change-request would need to be reviewed and approved for the change to be applied to the contact. An app calling the endpoint is not subject to such potential limitation.

Any update would be subject to the following:

• All mandatory details defined in the contact schema should be present following the data update.
• Additional details outside of the contact data schema are not allowed to be passed.
• If DFS is configured to derive the username from the contact’s email, and email is passed in context of the call, the endpoint would require a valid and unique email from the user.
• Arrays must be passed in full. Partially updating arrays (adding or removing entries) is unsupported.
  
  

  Possible ApiError.SubCode values:
  
  UsernameNotUnique: The provided username or email (when username is coupled with email) is not unique.
  

Retrieves contact external connections (e.g. the CBS or SSO external Id). The Id used for the import service is depicted with system “Default”.

Adds a contact external connections (e.g. the CBS or SSO external-id). External-Ids must be unique across all contacts (regardless of system input). External-id information may be routed internally according to the following:

• In order to register an external-id for the import service, use system name “Default”.
• In order to register an external-id for an external identity provider, the system name needs to match one of the defined identity providers.

Retrieves all relatives of a contact.

Retrieves contact’s username.

Updates the username of a contact. Endpoint should only be used if DFS is the identity provider and email is not coupled with username. Inputted username must be unique across all contacts.

Creates a new contact. the following applies:

• If no members were assigned to the contact, the default member is assigned.
• All mandatory details defined in the contacts schema should be inputted.Additional details outside of the contacts' data schema are not allowed.
• If DFS is the identity provider, “username” field in the request will be used and is required to be unique across all contacts.If DFS is configured to derive the username from the contact’s email, the “username” field in the request is required to match the contact’s email inputted in the “details” field.
  
  

  Possible ApiError.SubCode values:
  
  UsernameNotUnique: The provided username or email (when username is coupled with email) is not unique.
  

Searches details change history given criteria. Changes are returned grouped by submissions. Execution date refers to the time the changes took place, regardless of a potential approval process that may have preceded the execution.

Returns a CSV file containing the contacts that were requested using the 'POST /v1.0/contacts/export' service.

Returns a CSV file containing the legal-entities that were requested using the 'POST /v1.0/legal-entities/export' service.

Initiates the process to generate a CSV file containing details of the contacts selected (with all the attributes that are marked with ‘isExportable’ = true in the contact details schema) and responds with a jobId that identifies the process.

If the request body is empty, all the contacts will be returned in the CSV file.

If the request body has a GraphQl query, the contacts returned will be filtered based on the filters included in the query.

Initiates the process to generate a CSV file containing details of the legalentities selected (with all the attributes that are marked with ‘isExportable’ = true in the contact details schema) and responds with a jobId that identifies the process.

If the request body is empty, all the contacts will be returned in the CSV file.

If the request body has a GraphQl query, the contacts returned will be filtered based on the filters included in the query.

Checks the status of the Contacts / Legal Entities sync process

Imports contact JSON data files to dedicated storage.

This API is deprecated. Use POST /v1.1/contacts/import/sync-data instead

Syncs contact data files from dedicated storage to DFS System Tables. Each contact entry specified in the files would either create a new contact in DFS or update an existing one depending on prior existence of a contact with the specified externalId. See import documentation for more information on data structure required to execute the endpoint successfully. The endpoint syncs the information synchronously and returns a response once the sync is done.

Syncs contact data files from dedicated storage to DFS System Tables. Each contact entry specified in the files would either create a new contact in DFS or update an existing one depending on prior existence of a contact with the specified externalId. See import documentation for more information on data structure required to execute the endpoint successfully. The endpoint syncs the information asynchronously. Use statusId to check sync progress.

Imports legal entity JSON data files to dedicated storage.

This API is deprecated. Use POST /v1.1/legalentities/import/sync-data instead

Syncs legal entities data files from dedicated storage to DFS System Tables. Each legal entity entry specified in the files would either create a new legal entity in DFS or update an existing one depending on prior existence of a legal entity with the specified externalId. See import documentation for more information on data structure required to execute the endpoint successfully. The endpoint syncs the information synchronously and returns a response once the sync is done.

Syncs legal entities data files from dedicated storage to DFS System Tables. Each contact entry specified in the files would either create a new legal entity in DFS or update an existing one depending on prior existence of a legal entity with the specified externalId. See import documentation for more information on data structure required to execute the endpoint successfully. The endpoint syncs the information asynchronously. Use statusId to check sync progress.