DFS Client Services API (latest)

Retrieves change-request for details of the contact.

This API is deprecated. Use GET /v1.1/contacts/{contactId}/change-requests/{changeRequestId} instead.

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.

This API is deprecated. Use GET /v1.1/contacts/{contactId}/pending-change-request/check instead.

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).

This API is deprecated. Use POST /v1.0/contacts/change-requests/search instead.

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

Discontinues a verification flow for a pending communication channel. Pending details will be removed and sent key could not be validated anymore.

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 contact identifier by external connection.

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 the creating entity has participant(s) association, the contact will be associated with the same participant(s).
• If the creating entity is a member, that member will be directly associated with the contact.
• Specified details should include at least all mandatory fields as configured in the schema as well as email, if email is coupled with username. Details should not include any attribute which is not specified in the contact schema.
• If username is not coupled with email, and DFS is the identity provider, username field is mandatory.
  
  

  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.

This API is deprecated. Use GET /v1.1/contacts/{contactId}/details/change-history/search instead.

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.

Verifies a pending communication channel via a key sent to it. Key is sent following a communication mean update in contact details which is configured to require validation when updated, or when the key is directly resent via the dedicated endpoint.

Possible ApiError.SubCode values:

UsernameNotUnique: The provided username or email (when username is coupled with email) is not unique.
KeyExpired:        The key is no longer valid due to passing the expiration date or exceeding the number of allowed attempts.
KeyNoMatch:        The key supplied does not match the key generated for the contact in the channel provided.

Resends a key for a pending communication channel.

Anonymized all data related to the list of contacts passed in CRM data model in Tenant DB.

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.