Activates a contact directly. An activated contact can log in to a client facing app.

Activates a contact using an activation key. If DFS is the identity provider, response will be populated with information relevant for the next steps following activation.

Deactivates a contact directly. A deactivated contact cannot log in to a client facing app.

Sends an activation email to a contact. The email contains a generated key with an expiration time that will help the contact activate themselves. An activated contact can log in to a client facing app. If an activationUrl is not specified, the default one will be used.

Sends an activation email to a contact. The email contains a generated key with an expiration time that will help the contact activate themselves. An activated contact can log in to a client facing app. If an activationUrl is not specified, the default one will be used.

Retrieves change-request for details of the contact.

Enumerates change request statuses.

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.

Retrieves all details saved on a contact.

Partially updates any of the specified contact’s details. The following limitations apply:

• All mandatory details defined in the contacts schema should be present following the data update.
• Additional details outside of the contacts 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.

Updates contact details in full. All mandatory details defined in the contacts schema should be inputted. Additional details outside of the contacts schema are not allowed. If DFS is configured to derive the username from the contact’s email, the endpoint would require a valid and unique email from the user.

This API is deprecated. Use GET /v1.0/contacts/{contactId}/external-connections instead
Retrieves contact external connections (e.g. the CBS or SSO external Id). The Id used for the import service is depicted with system “Default”.

This API is deprecated. Use POST /v1.0/contacts/{contactId}/external-connections instead
Adds a contact external connections (e.g. the CBS or SSO external Id). To register an external Id for the import service, input it with system “Default”.

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). To register an external Id for the import service, input it with system “Default”.

This API is deprecated. Use GET /v1.0/contacts/{contactId}/member-profiles instead
The endpoint returns the profile(s) of the advisor(s) of the contact.

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

Partially updates the specified contact’s details which are allowed to be updated by the contact. The allowed fields are configured as part of the contact details schema configuration. The following limitations apply:

• All mandatory details defined in the contacts schema should be present following the data update.
• Additional details outside of the contacts 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.

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.

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.

Imports contact JSON data files to dedicated storage.

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.

Gets details of a legal entity

Updates a legal entity's details

Gets details of a legal entity by a contact or a member in the scope of a contact

Creates a legal entity

Retrieves schema information. This includes the schema components, JSON schema and fields metadata.

Updates schema definition. Updating the schema will automatically update the JSON schema and fields metadata. Should not be used outside of the schema editor.

This API is deprecated. Use GET /v1.0/schemas/{key}/json-schema instead
Retrieves JSON schema for the specified schema. Use for external validation of dynamic data.

Retrieves JSON schema for the specified schema. Use for external validation of dynamic data.

Retrieves all lists items used in Client Services.

Retrieve list items of a specific list used in Client Services.

This API is deprecated. Use GET /v1.0/schema/{key}/fields-metadata instead
Retrieves attributes of fields in the schema and on special properties of them in order to render contact lists.

Retrieves attributes of fields in the schema and on special properties of them in order to render contact lists.