Contact Role

Contact Role - Get

HTTP Request

GET /api/v1/contact-roles/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific contact role within the financial organization structure, identified by the provided ID, to facilitate understanding of organizational hierarchy and roles within the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Update

HTTP Request

PUT /api/v1/contact-roles/{id}

Interactive Demo

📋 Description: Updates the contact role associated with a specified identifier within the financial organization structure, ensuring accurate representation of roles within the entity’s hierarchy. This operation facilitates the management of organizational relationships and responsibilities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContactRoleDto	true	Request body containing updated contact role information, including role details and associated financial entity identifiers, to reflect changes in the organizational structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "partnerContactId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Delete

HTTP Request

DELETE /api/v1/contact-roles/{id}

Interactive Demo

📋 Description: Deletes a specified contact role within the financial organization structure, ensuring the integrity of the hierarchy and facilitating the management of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Delete Or Decommission

HTTP Request

PUT /api/v1/contact-roles/remove/{id}

Interactive Demo

📋 Description: Removes a specified contact role from the financial organization structure, ensuring that the hierarchy remains accurate and up-to-date. This operation is essential for maintaining the integrity of the organizational framework within financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Delete Or Decommission All

HTTP Request

PUT /api/v1/contact-roles/remove/bulk

Interactive Demo

📋 Description: Removes multiple contact roles from the financial organization structure in a single request, streamlining the management of organizational hierarchy within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of contact role identifiers to be removed in bulk from the financial organization’s structure, ensuring accurate hierarchy management.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Decommission

HTTP Request

PUT /api/v1/contact-roles/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified contact role within the financial organization structure, effectively removing it from the active hierarchy of the financial entity. This operation ensures that the organizational structure remains up-to-date and accurately reflects current roles.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/contact-roles/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions contact roles within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains current and relevant. This operation helps maintain an accurate representation of organizational roles and responsibilities.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning contact roles within the financial organization structure, ensuring that only roles modified before this date are affected.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Decommission Before Now

HTTP Request

PUT /api/v1/contact-roles/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions contact roles within the financial organization structure that were modified before the current date, ensuring the hierarchy remains up-to-date and relevant.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Decommission All

HTTP Request

PUT /api/v1/contact-roles/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple contact roles within the financial organization structure, enabling the effective management of organizational hierarchy and ensuring alignment with current business needs.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of contact role identifiers and associated metadata for the bulk decommissioning of roles within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Create Or Update Bulk

HTTP Request

PUT /api/v1/contact-roles/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple contact roles within the financial organization structure, ensuring accurate representation of the hierarchy and relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContactRoleDto	true	Request body containing a bulk array of contact role data, including identifiers and attributes necessary for updating or creating roles within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Create Or Update

HTTP Request

PUT /api/v1/contact-roles/createOrUpdate

Interactive Demo

📋 Description: Creates or updates contact roles within the financial organization’s structure, ensuring accurate representation of relationships and hierarchies among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContactRoleDto	true	Request body containing the details of contact roles, including role identifiers and associated financial entity information, to facilitate the creation or update within the organizational structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "partnerContactId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Bulk Update

HTTP Request

PUT /api/v1/contact-roles/bulk

Interactive Demo

📋 Description: Updates multiple contact roles within the financial organization structure, allowing for efficient management of relationships and hierarchy adjustments across financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContactRoleDto	true	Request body containing an array of contact role definitions, including attributes such as role name, hierarchy level, and associated financial entity, to facilitate bulk updates within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Bulk Create

HTTP Request

POST /api/v1/contact-roles/bulk

Interactive Demo

📋 Description: Submits a bulk creation request for contact roles within the financial organization structure, enabling efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContactRoleDto	true	Request body containing an array of contact role assignments to facilitate the organization and hierarchy of financial entities within the structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Bulk Delete

HTTP Request

DELETE /api/v1/contact-roles/bulk

Interactive Demo

📋 Description: Deletes multiple contact roles within the financial organization structure, allowing for streamlined management of organizational hierarchy and relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of contact role identifiers to be removed from the financial organization structure, facilitating the management of organizational hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Search

HTTP Request

POST /api/v1/contact-roles/search

Interactive Demo

📋 Description: Submits a search request for contact roles within the financial organization structure, allowing users to identify and retrieve specific roles associated with financial entities based on defined criteria.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	ContactRoleDtoFilter	false	Request body containing search criteria for identifying specific contact roles within the financial organization structure, including relevant attributes and filters.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "notDisplayIdIn": [
    "string"
  ],
  "nameLike": "string",
  "partnerContactIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContactRoleDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Detach Partner Contact

HTTP Request

POST /api/v1/contact-roles/detach/partner-contact/{contact_id}

Interactive Demo

📋 Description: Detaches a specified partner contact from the financial organization structure, thereby updating the hierarchy and relationships within the entity. This operation ensures accurate representation of roles within the organizational framework.

Parameters

Name	In	Type	Required	Description
contact_id	path	integer(int64)	true	Unique identifier for the partner contact to be detached from the financial organization structure.
body	body	ContactRoleDto	true	Request body containing the details necessary to detach a partner contact from the financial organization’s hierarchical structure, including the contact’s identification and relevant metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Attach Partner Contact

HTTP Request

POST /api/v1/contact-roles/attach/partner-contact/{contact_id}

Interactive Demo

📋 Description: Attaches a specified partner contact to the financial organization’s structure, facilitating the integration of key relationships within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
contact_id	path	integer(int64)	true	Unique identifier for the partner contact within the financial organization structure, used to establish roles in the hierarchy.
body	body	ContactRoleDto	true	Request body containing the details of the partner contact to be attached to the specified financial entity’s organizational structure, including relevant role and hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Find All

HTTP Request

GET /api/v1/contact-roles

Interactive Demo

📋 Description: Retrieves a list of contact roles within the financial organization structure, providing insights into the hierarchy and relationships of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of contact roles within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContactRoleDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Create

HTTP Request

POST /api/v1/contact-roles

Interactive Demo

📋 Description: Creates a new contact role within the financial organization structure, enabling the establishment of hierarchical relationships and responsibilities among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContactRoleDto	true	Request body containing the details of contact roles within the financial organization structure, including role identifiers and associated hierarchy information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "partnerContactId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContactRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerContactId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Get All By Partner Contact

HTTP Request

GET /api/v1/contact-roles/partner-contact/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific partner contact within the financial organization structure, identified by the provided ID, to facilitate effective management of organizational roles and relationships.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of partner contact roles within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContactRoleDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerContactId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact Role - Get Metadata

HTTP Request

GET /api/v1/contact-roles/meta

Interactive Demo

📋 Description: Retrieves metadata related to contact roles within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports effective management and understanding of organizational roles.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---