Return All Key Party Records Linked To A Profile

Request

This endpoint will return all created Key Party folders linked to the profile id.

Security

bearerToken

Path

profileIdstring, (uuid)required

Id of the profile

Query

entityTypestring

Entity type of the key party. Avaialable values are individual, business.

keyPartyTypesArray of strings

Type of the key party. Available values are director, shareholder, ubo and other.

pageinteger

Starting page number.

Default:1

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/keyparties?entityType=string&keyPartyTypes=string&page=1&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

itemsArray of objects(GetKeyPartiesResponseByProfileIdItems)

totalSizeinteger, (int64)

Response

{
  "items": [
    { … }
  ],
  "totalSize": 0
}