Download OpenAPI specification:Download
Contains functionality for managing client data.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Activates a contact directly. An activated contact can log in to a client facing app.
contactId required | integer <int32> The ID of the contact to activate |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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.
activationKey required | string The activationKey of the contact to activate |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "contactId": 20,
- "username": "jim.jones@additiv.ch",
- "isPasswordSet": true
}
Deactivates a contact directly. A deactivated contact cannot log in to a client facing app.
contactId required | integer <int32> The ID of the contact to deactivate |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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.
contactId required | integer <int32> The ID of the contact to send the activation email to |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
activationUrl | string Nullable Optional base URL that is used to compose the actual activation link sent in the email. If not specified then the DB dbo.GlobalSettings value 'FrontOfficeActivationContactUrl' in group 'Urls' will be used. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "activationUrl": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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.
contactId required | integer <int32> The ID of the contact to send the activation email to |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
activationUrl | string Nullable Optional base URL that is used to compose the actual activation link sent in the email. If not specified then the DB dbo.GlobalSettings value 'FrontOfficeActivationContactUrl' in group 'Urls' will be used. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "activationUrl": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves change-request for details of the contact.
contactId required | integer <int32> Contact Id |
changeRequestId required | integer <int32> Change request id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "uId": "string",
- "status": {
- "id": 0,
- "name": "string"
}, - "createDate": "2022-03-15T09:48:25Z",
- "initiatorMember": {
- "id": 0,
- "name": "string"
}, - "initiatorDescription": "string",
- "reviewDate": "2022-03-15T09:48:25Z",
- "reviewMember": {
- "id": 0,
- "name": "string"
}, - "reviewDescription": "string",
- "details": [
- {
- "path": "string",
- "originalValue": "string",
- "targetValue": "string",
- "isApprovalRequired": true
}
]
}
Enumerates change request statuses.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
{- "changeRequestStatuses": [
- {
- "id": 0,
- "name": "string"
}
]
}
Searches change-requests given criteria. A member can only see change requests for contacts which they have access to (with or without hierarchy).
memberId required | integer <int32> Member Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
page | integer <int32> |
pageSize | integer <int32> |
sortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
sortBy | string Nullable Sorting is available for Id, StatusId, CreateDate, InitiatorMemberId, ContactId, ReviewDate, ReviewMemberId. By default, the latest results would be returned first. |
includeHierarchy | boolean Search for change request of directly accessible contacts or include hierarchy accessible contacts as well |
statusId | integer <int32> Nullable |
createDateFrom | string <date-time> Nullable |
createDateTo | string <date-time> Nullable |
initiatorMemberIds | Array of integers <int32> Nullable |
contactIds | Array of integers <int32> Nullable |
reviewDateFrom | string <date-time> Nullable |
reviewDateTo | string <date-time> Nullable |
reviewMemberIds | Array of integers <int32> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortOrder": "Ascending",
- "sortBy": "string",
- "includeHierarchy": true,
- "statusId": 0,
- "createDateFrom": "2022-03-15T09:48:25Z",
- "createDateTo": "2022-03-15T09:48:25Z",
- "initiatorMemberIds": [
- 0
], - "contactIds": [
- 0
], - "reviewDateFrom": "2022-03-15T09:48:25Z",
- "reviewDateTo": "2022-03-15T09:48:25Z",
- "reviewMemberIds": [
- 0
]
}
{- "results": [
- {
- "id": 0,
- "contactId": 0,
- "status": {
- "id": 0,
- "name": "string"
}, - "createDate": "2022-03-15T09:48:25Z",
- "initiatorMember": {
- "id": 0,
- "name": "string"
}, - "reviewDate": "2022-03-15T09:48:25Z",
- "reviewMember": {
- "id": 0,
- "name": "string"
}
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}
Cancels a change-request. Cancelling is only possible from “pending” status, and can be done only by the member which initiated the change-request.
contactId required | integer <int32> Contact Id |
changeRequestId required | integer <int32> Change request id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves all details saved on a contact.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "hasPendingChangeRequest": true,
- "details": { }
}
Partially updates any of the specified contact’s details. The following limitations apply:
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
details | object |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "details": { }
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
details | object |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "details": { }
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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”.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "hasPendingChangeRequest": true,
- "details": { }
}
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”.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
External connection
externalId | string Nullable |
system | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "externalId": "string",
- "system": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Retrieves contact external connections (e.g. the CBS or SSO external Id). The Id used for the import service is depicted with system “Default”.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "hasPendingChangeRequest": true,
- "details": { }
}
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”.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
External connection
externalId | string Nullable |
system | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "externalId": "string",
- "system": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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.
contactId required | integer <int32> Contact Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "advisors": [
- {
- "id": 80,
- "firstName": "James",
- "lastName": "May",
- "email": "james.may@additiv.ch",
- "phone": "+1-284 4351245",
- "bankId": 1,
- "bankBranchId": 2,
- "hasProfilePicture": true,
- "isActivated": false
}, - {
- "id": 81,
- "firstName": "Ivan",
- "lastName": "Drago",
- "email": "ivan.drago@additiv.ch",
- "phone": "+1-284 4351245",
- "bankId": 2,
- "bankBranchId": 4,
- "hasProfilePicture": false,
- "isActivated": false
}
]
}
The endpoint returns the profile(s) of the advisor(s) of the contact.
contactId required | integer <int32> Contact Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "advisors": [
- {
- "id": 80,
- "firstName": "James",
- "lastName": "May",
- "email": "james.may@additiv.ch",
- "phone": "+1-284 4351245",
- "bankId": 1,
- "bankBranchId": 2,
- "hasProfilePicture": true,
- "isActivated": false
}, - {
- "id": 81,
- "firstName": "Ivan",
- "lastName": "Drago",
- "email": "ivan.drago@additiv.ch",
- "phone": "+1-284 4351245",
- "bankId": 2,
- "bankBranchId": 4,
- "hasProfilePicture": false,
- "isActivated": false
}
]
}
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:
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
details | object |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "details": { }
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
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.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
External connection
username | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "username": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Creates a new contact. the following applies:
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
contactTypeId | integer <int32> |
memberIds | Array of integers <int32> Nullable |
username | string Nullable |
details | object |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "contactTypeId": 0,
- "memberIds": [
- 0
], - "username": "string",
- "details": { }
}
{- "id": 0,
- "details": null
}
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.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
memberIds | Array of integers <int32> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "memberIds": [
- 0
]
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Manages member assignment to a contact. The assigned members and all members with hierarchy access to them would have access to all contact information.
contactId required | integer <int32> Contact id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
memberIds | Array of integers <int32> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "memberIds": [
- 0
]
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Imports contact JSON data files to dedicated storage.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "files": [
- {
- "fileName": "string",
- "fileLength": 0,
- "uploadDate": "2022-03-15T09:48:25Z"
}
]
}
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.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "failedExternalIds": [
- "string"
]
}
Gets details of a legal entity
legalEntityId required | integer <int32> Legal entity id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "contactGroupId": 0,
- "details": null
}
Updates a legal entity's details
legalEntityId required | integer <int32> Legal entity id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
details | any |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "details": null
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Gets details of a legal entity by a contact or a member in the scope of a contact
contactId required | integer <int32> The ID of the contact |
legalEntityId required | integer <int32> Legal entity id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "contactGroupId": 0,
- "details": null
}
Creates a legal entity
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
contacts | Array of objects (LegalEntityContactAccessPolicyRequest) Nullable |
details | any |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "contacts": [
- {
- "contactId": 0,
- "accessPolicyId": 0
}
], - "details": null
}
{- "id": 0,
- "details": null
}
Retrieves schema information. This includes the schema components, JSON schema and fields metadata.
key required | string Schema key |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "id": 0,
- "key": "string",
- "schema": "string",
- "jsonSchema": "string",
- "concurrencyToken": 0
}
Updates schema definition. Updating the schema will automatically update the JSON schema and fields metadata. Should not be used outside of the schema editor.
key required | string The parameter key |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
schema | string Nullable |
jsonSchema | string Nullable |
concurrencyToken | integer <int64> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "schema": "string",
- "jsonSchema": "string",
- "concurrencyToken": 0
}
{- "concurrencyToken": 0
}
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.
key required | string Schema key |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "jsonSchema": "string"
}
Retrieves JSON schema for the specified schema. Use for external validation of dynamic data.
key required | string Schema key |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "jsonSchema": "string"
}
Retrieves all lists items used in Client Services.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Server Error
{- "items": [
- {
- "id": 0,
- "label": "string",
- "listKey": "string"
}
]
}
Retrieve list items of a specific list used in Client Services.
listKey required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "items": [
- {
- "id": 0,
- "label": "string",
- "listKey": "string"
}
]
}
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.
key required | string Schema key |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "fields": [
- {
- "key": "string",
- "label": "string",
- "fieldType": "Boolean",
- "listKey": "string",
- "isFilterable": true,
- "isSortable": true,
- "isArrayItem": true,
- "maxLength": 0,
- "tooltip": "string"
}
]
}
Retrieves attributes of fields in the schema and on special properties of them in order to render contact lists.
key required | string Schema key |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "fields": [
- {
- "key": "string",
- "label": "string",
- "fieldType": "Boolean",
- "listKey": "string",
- "isFilterable": true,
- "isSortable": true,
- "isArrayItem": true,
- "maxLength": 0,
- "tooltip": "string"
}
]
}