DFS v26.1
Loading
API docs by Redocly

DFS Contact Relationship Services API (latest)

Download OpenAPI specification:

Contains functionality around contact relationship.

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.

ContactAccessManagement

Remove association of one or more participants from the specified contact

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.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

participantUids
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "participantUids": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Associate one or more participants to the specified contact

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.
Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

participantUIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "participantUIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Return the profiles of the contact's advisors

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

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "advisors": [
    ]
}

Return the profile picture of a contact's advisor

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

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact Id

memberId
required
integer <int32>

Member Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "imageContentBase64": "iVBORw0KGgoAAAANSUhEUgAAALgAAAA8CAYAAADVEnAJAAAOvklEQVR42u1dCZBcRRluyM4Sbg9QuUTFYAhy7Zs3G2Nw5r2ZTWKMWBCXQ5QzIncEFIqjGGtnZpdwaEUOIYcFlBwVRBA5wh7hUIIQCFgkJCAWBUWSnZ3N9d7MXgk7/p/sZje72/3umR2rv6quDOyb1zXd3/v77+///37MD0STxapYY6FWT+ev0zP5h7W0sTqWyWdjGaNA/13UU0Yf/ZvT08bbWjr/GH2+Qc8YJyv3FUNMQmK8Qk8XIrGM+Qc9ld8CIjttn33PvC/elD+JSUiMFxAp64igL4GkvrW08TytADVMouIQfnRucazGKg11qe6v62nzryBkIC1l9NO/d0eT2f2YhCR4ia32T2MpMw8iBt20TP79eIN5HJOQBA8a9cuKE8h1uAfEK3EzY+n8TCYhCR4QoI5MJMv9pF1SxlLGTrLyK+nzQvreZfGUeYbWWDhFy5inU7uCFJS7Ymnjdbgidu6Ha/GAMQlJ8ADIXaWlzSdsqiHv6JnCL6Y3bfu8LV8+aX6JHoD59L1/Czadb8cbt3+RSUiCBwHId5YWNmN8AuucTBb3dPsQkfszDxr57vc23pLklgQPDES68yw3gqn8I7OSnQcw+xBb9LTxDO6LIJEktyR4sFJgyuiyUDluYsXiHsxHYBUgCfKXM5LbvsAkJMGDAEhL7sFyC+t9A5OQqESCQ5YTk9tcymC5JSQqjeAgLiQ+AcHXz0kW92ESEpVIcGQDihUTM84kJCqV4JAFBZvKFiYhUakER7SQ8rc38wgeb8zPYhWOjkTtpGxcvSQbDy+m1tauK6vQ8JnaEvytI64ezQJCT3P1pL7mqkt2tExY3NsSatvRGlqF9r/PzROW4G89LdWB9Z+4ZcuBlN58KgXvMhRge4hW5KeQm09y7+0UMZ47bUFu/3ITvKgooQ5N/V5WV69r19WlHbr6JM3LUzQvD3bo4Ztpvuren/XNvZhTaE0Fhe+eGBsrNVyOAcvGI+eAyDRIRTutPa6+SQN8Hr7ruf83WGhnS+icATIX7TQi+5u9raHz8F2fYho1tAI/SkG5XougXYGu/f30jHHwZ98z6xFNHtlQ0OI3wbNR9Ssd8fACGv+c9fyEt+DaDVHlIGYXlDNyNd89MRezCkQ2oUzPxpW1GBQ3LauF34U1YS7R11I1nci6FqR11ya829dW5bp/BMvIOD3gNMktlsp3YsUma38xJ4XiDb8IXkyyPTviylU0znmn8wOi5+Lq2fYseNpcwiV4On9ORVltxvYgl+P6dk39lDc4Dqx5Py2TN+Ke9sUotgeR+3qywp+CqF5ab3Oov6+16kbc0+mKrGWMj8VkFifNYd8VJMGz0Sn7tevhp73OEc317XhQmAj01L7M+7FY4iqJ3DRoC/HDfW26ejfubYfcRMyFIKfP7W67JEetK1KN/UhZDorgm+qO35es9t/9mh/MOeZHRPC1vB/kNS8kiEGmDfGdbAzA2uIHB9RuYhaAtQUhg2i0Klj2rzWYx9LYbMcYjVeCg4g0lo/5PT8QCRgPouWsPlmsHm8ER9kcG4FcXInBpRBbYuUt2p1fDLUEu3G03AxlclZXLidfcI2lu5IIRxkHpI7E4FJY+NVv0UNwMdSS/mfZXmg9y6sn0/+7nPz1NZbuSnMVt38E4UgdWWdhGDYTQW9DTS1yjqK3FA5PpIzptM/6DSkpG0pB8A49cqF476P20ib/PrruZLgxeCA2zjrx4Jwe/iEUFe53NbUHc/l/QXC4VLtZhfop1UTA9fyBU7rIus/DYIk3POqVGGD+UqiuG0tdKS5j1UTQ9QJydpFPPq9YFPdPVvpKuq5X8ICs46krRNpGYYJc2rwX2Z+iB4QegN8FSfCt0RM+l9WUzSIFC3IuE4B87rm8OYLkizmucBcFzVjFhoEUj/MFT3YhW6d8l9kEtFYRySE7shHobQudzyMlEbbQ93yV7f6JxHUikkN2ZCNwcjp/CG0MewRjdq13Rc07wbH558+TsjI3bZotLR6GSKCuJLxvMsvvovyTDQNcD94PJinpJ8wh4MYIBnDUBMP14BKyOeS4f7gxXCveEhrVP7kYacFY/dFpThK0bl8JPiQJfsix3FtziZMOtRUI0iP1NAcvCx6U50Z9EVp3UDJhMMdL5FvZAOB3Cfy5F/huiVifFQWHslrNUYPXwocWWO8XikV3/YuCQ91tex21e5Kc8RHvYCV7ZYSjVwRaJbv9JHhOq1UEKtWNTACQnyKZSZJ+N1htNiEPI3A0kuBXCXy3JaxMgFrCmbiHdi17evgyrvXWwqcwlyBLcBZ3IBPqz4dZ28u41rat2nX/O9tCZwl8+l39JxqMYwTW9jbmElrauN9PgtO4Xc0dz5k1h4yltkA4oKjlsva4ssOumgL5sTNRe8yocK5gkDahdrIsBE/lV3Aeuswwv24xZ2PZbZW3YBmI0JSdPF18mHqymEPCbqgkrjX9F9h+tALs5OnidsoL441d33FN8Ixxmq8E18L3c9yT9WwY4IfTnF4KVcsBqfOksNzbrtcezy0XQ4iWa8Ub87NZiYGDOXkBCy1lnjWM4G28HTnzCAyylZ+HZCleTgnzCJ50SMTf1T8edt4pYbMW9rt+wKJN3V/zkeCYpxWisdykqcfCcND/M+0SG6oWEfuKLQnlQGYFHKIpkOVWlCF9V+MXPG/b5YPCV+YQ/FnPBNfUFt6Of/Aa+MocC+65fyJyC8eC7+ofR91x3LgO5gGQh/0kOAwOL+eHiPqibVJjVdXVx3NaRIcb4+ikWPyA8ZIyi90/J0/io+Flc7SRfL3MBH+9PAQXGyYcX+31XBxfCa6pq71FK5V22m81dEYjh3soODZfEZD8g6Gc4WCBCBtP10VK5wiJsJWzm15dAhcFJGzlBGVWl8hFWcBLmPKyd0osKBzqJ8Fhpd0lvCkv0UbzDATz/DkWWXxcxJ9KUXQs0mGj6UJ4N99OVxbxQr4fT526N3MJbHY4m0y0O4dp4Is4JOztX8lc99//D7Y/d5PZEtrVP04U449V/kTmElixfd1k6uEHnGwa6fp72uM1xwVwbIT5tEVlfUPA5L5Q0PerbASQZCNIpZzLXAIBIkGu+PmD16EShx+UqXbdPwJEvPsicjp4HR54QZAuyVwCK2WQMiHPH0deUOesyAEsKGD3jOoOi0hiEx6GYI5oNnYKJuz7Y4RtjxaFf90GehCx5N1384zwEYPXInFKkCS10m2gBxFL3n37l088wl65obHRzUkIyFmh72/1VUWpU08UqCEbc3pEczVX0ahzN4xkwZ9Zp6yaT/l1ChV8RawM4mQh4znOQ8XdoaMhyYo5BHRYUSBhDF/5TUE0c56LaqBLBQ/NqP5xaq+PwR5Y79/6HqpHrr6mvMfL1OzUlYiLYNxs3JMs/zRmFzz5iSdF0eBe4GUzg+oT5JZY9LV1RqrrCD4h1XNF6ZftCTVuv9RNnUkD3ufE7aEEqHMFBO+lByDuYGM5kxSYPiduj9aw/VuiI6kRDGI2gcNUA0q2gh8+X+CifIC0WGYTIDU088HwPOo0P4xGJzo9+fVxm/khHyALDTkMzAYQgIil8z/AKmDjBNtPEWiyLi5W1opIjgy0Yn09t3gaf4OfKAoLw22B+zBWcTHqL0UkRyospdVy+8ff6Jqridw7RIlW6J/j3i21cCtTotRnuDp0j2sw3kERfMMcZR8a30944zswh0dbVW1hVUaketQ9oHrpNTUMsE3EjPkXh7na/6LBXITBQqIWjiRA5BEH4mO5pL83O3wVyoV2i4yH6jCFA3hlpx6ZgqcdDZ9hWRAVsyh46MPgiYqMreow8RCA6D2t1VMoFD8RDZ8pn2U+cr0tCh766P7c/lENj7QK8YprfohXPWpN+RPgmyNanGjYPglKDOatFAUPNM6nWigoPVCp2hORqZAGB0ndqU89jKz0BXBHxd8PZ/EgOTozhbOjDrRhs+lkaQWyeuTaoErWoNbYSHO9NqiSNag11tFoI4p3ko7nkjUAIXlbGjgMlqZ0QjZ0cP1stwrHmeRzG6UgN1QBaPKuKuq18B1+kxupmgywV3R8h+/kbq1KOvGhYRzGM8GhfJA1fsLPOcJGFRbe4+lIXV+lH/nnYAluLOdsKG2TPKer1wwFadw3+O65ePgi5gAgORHyGk6QhtNEvnvoIhcq2GxyObZ5Wz2N570TXLxvGsoE9dhQtaUrP/Y1EQoJWD4XMayDv+6Xvr4pVlOLSh8PVvvVrBY5gblE34qq2qFKH1ftVQrouO4/3tT9DRSGuKh33UZRzDm+H/wjDqjlPLiOrw3lf/sMRNEGihJyLi1FD97ihjexuX3PDyBURhLq6TQQrzhIwXyRdvo/GlIr3APKCEUkT9/RHHrFAbFfJCnQl/5hLKBWoSTRptV+kIh92EA++CVjX2eu9PvoNqS74uxBUkE2OTlij75zJsapJId3Qs8m1eTXyFdBUTB29FBLoM/iXDxo5tipg9CoIcQyWso3Gm/UTjpyoDj5LmQagvRo9PkZ7NpRTIydOgsI/W0Tj0SInaS+u5BpCNKjUT75M8gtQTFxf+vehwX5ahpYZZQnwrKTOvYaXseOyh2oKNFb87uVeUEF47mQowj+yGlvjNXcRCUR0STXJY1Tr2gz+g65iR+hlhPJc6juoTn81aa68LeZhIQX8I6QwAPBJCTGA6BzM5eAdZfvaJIYd0BwjqLKZyPzEq9gd5cbZBxErsiOsQguX68uURagSATheFTyDN84ujnXBke5ceo8+1D0wiQkSgmUG4LMHNXjP2TNv+xAAj6edyaKljb/xiQkyvEKGlJG3hFo2+/h/BR7D0q+XVCXO4dJSJQD5HfHrGIOJOHeEc0Yk6GPD88apXjGVBzwJA7xG6vkO1Ilyv2mvFvtvqaE/l1DhH8f7oidIFC8saAyCYlyAtaYk97ssZnzmYRESSE+sOdhHwl+M5OQGG+vZYfVJVmvy0Py2xa8SpBJSJQb4vMFzaXIBXJAbAMvh0Wwh0lIVAJAVgr4zBtwXdbgRVWovUTgBrIgop44Ag7pynW39e/LJCQkKgP/BTwUobIIDirVAAAAAElFTkSuQmCC",
  • "isDefaultImage": false
}

Assign a member to a 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.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

memberIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "memberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Manage member assignment to a contact

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

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

memberIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "memberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Search for members assigned to the specified contacts

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.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

contactUids
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "contactUids": [
    ]
}

Response samples

Content type
application/json
{
  • "memberAccess": [
    ]
}

ContactGroupAccess

Validate whether a contact has access to a contact group Deprecated

Validates whether a contact has access to a contact group This API is deprecated. Use GET /v1.1/contact-groups/{contactGroupUId}/contacts/{contactId}/access.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

contactGroupId
required
integer <int32>

Contact group id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "hasAccess": true
}

Validate whether a member has access to a contact group Deprecated

Validates whether a member has access to a contact group This API is deprecated. Use GET /v1.1/contact-groups/{contactGroupUId}/members/{memberUId}/access

Authorizations:
Bearer
path Parameters
identityId
required
string <uuid>

Identity id

contactGroupId
required
integer <int32>

Contact group id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "hasAccess": true
}

Validate whether a contact has access to a contact group

Validates whether a contact has access to a contact group

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

Contact id

contactGroupUId
required
string <uuid>

Contact group uid

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "hasAccess": true
}

Validate whether a member has access to a contact group

Validates whether a member has access to a contact group

Authorizations:
Bearer
path Parameters
memberUId
required
string <uuid>

Member uid

contactGroupUId
required
string <uuid>

Contact group uid

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "hasAccess": true
}

ContactGroupManagement

Delete a contact group

Deletes a contact group. The caller may delete a group only if they have access to all contacts in the group. Groups belonging to legal entities may not be deleted.

Authorizations:
Bearer
path Parameters
contactGroupId
required
integer <int32>

The ID of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve details of a contact group

Retrieves details of a contact group. The caller may retrieve details of a group if they have access to at least one contact in the group.

Authorizations:
Bearer
path Parameters
contactGroupId
required
integer <int32>

The ID of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "groupId": 0,
  • "groupUid": "509be368-571f-4f0e-ad62-2862585799ff",
  • "groupName": "string",
  • "groupExternalId": "string",
  • "customAttributes": "string",
  • "contacts": [
    ],
  • "legalEntityUid": "4eeaf083-0f33-4f2f-b08a-975aeabcda25"
}

Modify a contact group

Modifies a contact group. The caller may modify a group only if they have access to all contacts in the group. If the group belongs to a legal entity, only corporate contacts may be included in the group and exactly one of them needs to be the main company contact. If the group does not belong to a legal entity, only private contacts may be included.

Authorizations:
Bearer
path Parameters
contactGroupId
required
integer <int32>

The ID of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

groupName
string or null
groupExternalId
string or null
customAttributes
string or null
Array of objects or null (Api.ContactGroupManagement.ModifyContactGroup.Contact)

Responses

Request samples

Content type
{
  • "groupName": "string",
  • "groupExternalId": "string",
  • "customAttributes": "string",
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve details of all contact groups of a contact

Retrieves details of all contact groups of a contact (even if the caller does not have access to some of the contacts in these groups).

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The ID of the contact

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Create a new contact group

Creates a new contact group. Only private contacts may be included in the created group. A Group belonging to a legal entity is created when creating a legal entity.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The ID of the contact

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

groupName
string or null
groupExternalId
string or null
customAttributes
string or null
Array of objects or null (Api.ContactGroupManagement.CreateContactGroup.Contact)

Responses

Request samples

Content type
{
  • "groupName": "string",
  • "groupExternalId": "string",
  • "customAttributes": "string",
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0
}

Retrieve contact group access policies

Retrieves list of available access policies for a contact to be used in context of a group. Note that access policies are descriptive only and do not embody any access logic.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "accessPolicies": [
    ]
}

Retrieve details of a contact group

Retrieves details of a contact group. The caller may retrieve details of a group if they have access to at least one contact in the group.

Authorizations:
Bearer
path Parameters
contactGroupUId
required
string <uuid>

The UId of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "name": "string",
  • "externalId": "string",
  • "customAttributes": "string",
  • "contacts": [
    ],
  • "legalEntityUid": "4eeaf083-0f33-4f2f-b08a-975aeabcda25"
}

Search contact groups

Searches contact groups given criteria.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

contactIds
Array of integers or null <int32> [ items <int32 > ]
contactGroupIds
Array of integers or null <int32> [ items <int32 > ]
contactGroupUids
Array of strings or null <uuid> [ items <uuid > ]
name
string or null
externalIds
Array of strings or null

Responses

Request samples

Content type
{
  • "contactIds": [
    ],
  • "contactGroupIds": [
    ],
  • "contactGroupUids": [
    ],
  • "name": "string",
  • "externalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

ContactRelativeManagement

Retrieve all relatives of a contact

Retrieves all relatives of a contact.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The contactId of the contact

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]