Vendor Security Profile

Vendor Security Profile - Get

HTTP Request

GET /api/v1/vendor-security-profiles/{id}

Interactive Demo

📋 Description: Retrieves the security profile for a specified vendor within the financial organization structure, providing insights into the organization’s hierarchy and risk management practices.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVendorSecurityProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "vendorListType": "ALL",
    "vendorList": [
      {
        "id": 0,
        "status": "CREATED",
        "displayId": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "name": "string",
        "fax": "string",
        "phone": "string",
        "parentId": 0,
        "parentName": "string",
        "parentDisplayId": "string",
        "companyId": 0,
        "partnerRoleId": 0,
        "partnerContactId": 0
      }
    ],
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
}

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

Vendor Security Profile - Update

HTTP Request

PUT /api/v1/vendor-security-profiles/{id}

Interactive Demo

📋 Description: Updates the vendor security profile associated with the specified ID, allowing financial organizations to maintain accurate and compliant security information within their organizational structure.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	VendorSecurityProfileDto	true	Request body containing the updated vendor security profile data, including compliance requirements and risk assessments relevant to the financial organization structure.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "vendorListType": "ALL",
  "vendorList": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ],
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVendorSecurityProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "vendorListType": "ALL",
    "vendorList": [
      {
        "id": 0,
        "status": "CREATED",
        "displayId": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "name": "string",
        "fax": "string",
        "phone": "string",
        "parentId": 0,
        "parentName": "string",
        "parentDisplayId": "string",
        "companyId": 0,
        "partnerRoleId": 0,
        "partnerContactId": 0
      }
    ],
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
}

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

Vendor Security Profile - Delete

HTTP Request

DELETE /api/v1/vendor-security-profiles/{id}

Interactive Demo

📋 Description: Deletes a specified vendor security profile within the financial organization structure, ensuring the integrity of the hierarchy and compliance with security protocols.

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

Vendor Security Profile - Create Or Update Bulk

HTTP Request

PUT /api/v1/vendor-security-profiles/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple vendor security profiles in bulk, enabling efficient management of organizational structures within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	VendorSecurityProfileDto	true	Request body containing bulk vendor security profile data, including organizational hierarchy details and compliance attributes for financial entities.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "vendorListType": "ALL",
    "vendorList": [
      {
        "id": 0,
        "status": "CREATED",
        "displayId": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "name": "string",
        "fax": "string",
        "phone": "string",
        "parentId": 0,
        "parentName": "string",
        "parentDisplayId": "string",
        "companyId": 0,
        "partnerRoleId": 0,
        "partnerContactId": 0
      }
    ],
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListVendorSecurityProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "vendorListType": "ALL",
      "vendorList": [
        {
          "id": 0,
          "status": "CREATED",
          "displayId": "string",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "name": "string",
          "fax": "string",
          "phone": "string",
          "parentId": 0,
          "parentName": "string",
          "parentDisplayId": "string",
          "companyId": 0,
          "partnerRoleId": 0,
          "partnerContactId": 0
        }
      ],
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ]
}

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

Vendor Security Profile - Create Or Update

HTTP Request

PUT /api/v1/vendor-security-profiles/createOrUpdate

Interactive Demo

📋 Description: Creates or updates vendor security profiles within the financial organization structure, ensuring alignment with the organization’s hierarchy and compliance requirements.

Parameters

Name	In	Type	Required	Description
body	body	VendorSecurityProfileDto	true	Request body containing the vendor security profile data, including organizational hierarchy details and compliance information for financial entities.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "vendorListType": "ALL",
  "vendorList": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "fax": "string",
      "phone": "string",
      "parentId": 0,
      "parentName": "string",
      "parentDisplayId": "string",
      "companyId": 0,
      "partnerRoleId": 0,
      "partnerContactId": 0
    }
  ],
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVendorSecurityProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "vendorListType": "ALL",
    "vendorList": [
      {
        "id": 0,
        "status": "CREATED",
        "displayId": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "name": "string",
        "fax": "string",
        "phone": "string",
        "parentId": 0,
        "parentName": "string",
        "parentDisplayId": "string",
        "companyId": 0,
        "partnerRoleId": 0,
        "partnerContactId": 0
      }
    ],
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
}

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

Vendor Security Profile - Bulk Update

HTTP Request

PUT /api/v1/vendor-security-profiles/bulk

Interactive Demo

📋 Description: Updates multiple vendor security profiles in bulk, allowing financial organizations to efficiently manage and enhance their security measures within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	VendorSecurityProfileDto	true	Request body containing a collection of vendor security profile data, including organizational hierarchy details and compliance metrics for financial entities.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "vendorListType": "ALL",
    "vendorList": [
      {
        "id": 0,
        "status": "CREATED",
        "displayId": "string",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "name": "string",
        "fax": "string",
        "phone": "string",
        "parentId": 0,
        "parentName": "string",
        "parentDisplayId": "string",
        "companyId": 0,
        "partnerRoleId": 0,
        "partnerContactId": 0
      }
    ],
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListVendorSecurityProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "vendorListType": "ALL",
      "vendorList": [
        {
          "id": 0,
          "status": "CREATED",
          "displayId": "string",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "name": "string",
          "fax": "string",
          "phone": "string",
          "parentId": 0,
          "parentName": "string",
          "parentDisplayId": "string",
          "companyId": 0,
          "partnerRoleId": 0,
          "partnerContactId": 0
        }
      ],
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ]
}

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

Vendor Security Profile - Bulk Delete

HTTP Request

DELETE /api/v1/vendor-security-profiles/bulk

Interactive Demo

📋 Description: Deletes multiple vendor security profiles in bulk, streamlining the management of financial entity hierarchies within the organization’s structure.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of vendor security profile identifiers to be deleted in bulk, relevant to the organization’s financial structure and 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

Vendor Security Profile - Search

HTTP Request

POST /api/v1/vendor-security-profiles/search

Interactive Demo

📋 Description: Submits a request to search for vendor security profiles within the financial organization structure, enabling users to identify and assess security measures associated with various financial entities.

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	VendorSecurityProfileDtoExtendedFilter	false	Request body containing the vendor security profile search criteria, including parameters related to the organization structure and hierarchy of financial entities.

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",
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "nameLike": "string",
  "vendorIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageVendorSecurityProfileDto

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,
      "displayId": "string",
      "name": "string",
      "vendorListType": "ALL",
      "vendorList": [
        {
          "id": 0,
          "status": "CREATED",
          "displayId": "string",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "name": "string",
          "fax": "string",
          "phone": "string",
          "parentId": 0,
          "parentName": "string",
          "parentDisplayId": "string",
          "companyId": 0,
          "partnerRoleId": 0,
          "partnerContactId": 0
        }
      ],
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ],
  "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

Vendor Security Profile - Find All

HTTP Request

GET /api/v1/vendor-security-profiles

Interactive Demo

📋 Description: Retrieves vendor security profiles associated with the financial organization structure, enabling users to assess and manage the security posture of various financial entities within the hierarchy.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results returned from the vendor security profiles endpoint should be paginated, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageVendorSecurityProfileDto

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,
      "displayId": "string",
      "name": "string",
      "vendorListType": "ALL",
      "vendorList": [
        {
          "id": 0,
          "status": "CREATED",
          "displayId": "string",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "name": "string",
          "fax": "string",
          "phone": "string",
          "parentId": 0,
          "parentName": "string",
          "parentDisplayId": "string",
          "companyId": 0,
          "partnerRoleId": 0,
          "partnerContactId": 0
        }
      ],
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string"
    }
  ],
  "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

---