DFS Contact Group Services API (latest)

Download OpenAPI specification:Download

Contains functionality around contact groups.

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.

ContactGroupAccess

Validate whether a contact has access to a contact group related entity (e.g. Legal entities, Accounts)

Validates whether a contact has access to a contact group related entity (e.g. Legal entities, Accounts)

Authorizations:

Bearer

path Parameters

contactId required	integer <int32> Contact id
entityId required	integer <int32> Entity id
entityType required	string (EntityTypeLinkedWithContactGroupKey) Enum: "Account" "LegalEntity" "Portfolio" "PortfolioProposal" Entity type

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contact-groups/contacts/{contactId}/{entityType}/{entityId}/access

https://example-host/v1.0/contact-groups/contacts/{contactId}/{entityType}/{entityId}/access

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"hasAccess": true
}

Validate whether a member has access to a contact group related entity (e.g. Legal entities, Accounts)

Validates whether a member has access to a contact group related entity (e.g. Legal entities, Accounts)

Authorizations:

Bearer

path Parameters

identityId required	string <uuid> Identity id
entityId required	integer <int32> Entity id
entityType required	string (EntityTypeLinkedWithContactGroupKey) Enum: "Account" "LegalEntity" "Portfolio" "PortfolioProposal" Entity type

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contact-groups/identities/{identityId}/{entityType}/{entityId}/access

https://example-host/v1.0/contact-groups/identities/{identityId}/{entityType}/{entityId}/access

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"hasAccess": false
}

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
contactGroupId required	integer <int32> Contact group id

header Parameters

Accept-Language

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contact-groups/{contactGroupId}/contacts/{contactId}/access

https://example-host/v1.0/contact-groups/{contactGroupId}/contacts/{contactId}/access

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

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

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contact-groups/{contactGroupId}/identities/{identityId}/access

https://example-host/v1.0/contact-groups/{contactGroupId}/identities/{identityId}/access

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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.

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/contactgroups/{contactGroupId}

https://example-host/v1.0/contactgroups/{contactGroupId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/contactgroups/{contactGroupId}

https://example-host/v1.0/contactgroups/{contactGroupId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"groupId": 0,
"groupName": "string",
"groupExternalId": "string",
"customAttributes": "string",
"contacts": 
[
{"contactId": 0,
"contactName": "string",
"contactExternalId": "string",
"comment": "string",
"customAttributes": "string",
"calculatedRiskCategory": 
{"id": 0,
"name": "string"
},
"chosenRiskCategory": 
{"id": 0,
"name": "string"
},
"accessPolicy": 
[
{"key": "BeneficialOwner",
"name": "string",
"id": 0
}
]
}
]
}

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.

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:
application/json

The parameter DTO.

groupName	string Nullable
groupExternalId	string Nullable
customAttributes	string Nullable
contacts	Array of objects (Api.ContactGroupManagement.ModifyContactGroup.Contact) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

put/v1.0/contactgroups/{contactGroupId}

https://example-host/v1.0/contactgroups/{contactGroupId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"groupName": "string",
"groupExternalId": "string",
"customAttributes": "string",
"contacts": 
[
{"contactId": 0,
"comment": "string",
"customAttributes": "string",
"chosenRiskCategoryId": 0,
"accessPolicyIds": 
[0
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v2.0/contacts/{contactId}/contactgroups

https://example-host/v2.0/contacts/{contactId}/contactgroups

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"groups": 
[
{"groupId": 0,
"groupName": "string",
"groupExternalId": "string",
"customAttributes": "string",
"contacts": 
[
{"id": 0,
"name": "string",
"accessPolicies": 
[
{"key": "BeneficialOwner",
"name": "string",
"id": 0
}
]
}
]
}
]
}

Create a new contact group

Creates a new contact group.

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:
application/json

The parameter DTO.

groupName	string Nullable
groupExternalId	string Nullable
customAttributes	string Nullable
contacts	Array of objects (Api.ContactGroupManagement.CreateContactGroup.Contact) Nullable

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/contacts/{contactId}/contactgroups

https://example-host/v2.0/contacts/{contactId}/contactgroups

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"groupName": "string",
"groupExternalId": "string",
"customAttributes": "string",
"contacts": 
[
{"contactId": 0,
"comment": "string",
"customAttributes": "string",
"chosenRiskCategoryId": 0,
"accessPolicyIds": 
[0
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

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:
application/json

The parameter DTO.

contactIds	Array of integers <int32> Nullable
contactGroupIds	Array of integers <int32> Nullable
name	string Nullable
externalIds	Array of strings Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/contact-groups/search

https://example-host/v1.0/contact-groups/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"contactIds": 
[0
],
"contactGroupIds": 
[0
],
"name": "string",
"externalIds": 
["string"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"name": "string",
"externalId": "string",
"contacts": 
[
{"id": 0,
"name": "string"
}
]
}
]
}

DFS Contact Group Services API (latest)

ContactGroupAccess

Validate whether a contact has access to a contact group related entity (e.g. Legal entities, Accounts)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Validate whether a member has access to a contact group related entity (e.g. Legal entities, Accounts)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Validate whether a contact has access to a contact group

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Validate whether a member has access to a contact group

Authorizations:

path Parameters

header Parameters

Responses

Response samples

ContactGroupManagement

Delete a contact group

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Retrieve details of a contact group

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modify a contact group

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve details of all contact groups of a contact

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create a new contact group

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Search contact groups

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json