Skip to content
Connect API Catalog/
/
/
Update The Key Party By P...

Update The Key Party By Profile Id and Key Party Id

Request

Updates a key party on a profile by Id. Returns the updated key party data.

Security
bearerToken
Path
profileIdstring, (uuid)required

id of the profile

keyPartyIdstring, (uuid)required

id of the keyParty

Bodyapplication/json

Modified key party

namestring or null

Name of the key party Maximum length is 200 characters

firstNamestring or null

First name of the key party
Valid for only entity type Individual
Maximum length is 200 characters combining First name, Middle name and Last name

middleNamestring or null

Middle name of the key party
Valid for only entity type Individual
Maximum length is 200 characters combining First name, Middle name and Last name

lastNamestring or null

Last name of the key party
Valid for only entity type Individual
Maximum length is 200 characters combining First name, Middle name and Last name

genderstring or null

Gender of the key party Valid for entity type Individual (male, female)

dateOfBirthstring or null, (date)

Date of birth of the key party Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future
Valid for the entity type Individual

organisationNumberstring or null


Key party organisation number
Valid for entity type Business

activityCodestring or null

Activity code of the key party
Valid for entity type Business

percentageOfSharesnumber or null, (double)

Share percentage of the key party
Valid for key party type ShareHolder

rolestring or null

Role of the key party
Valid for key party type Director

countryCodestring or null

Country code of the key party

addressobject
curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "dateOfBirth": "2019-08-24",
    "organisationNumber": "string",
    "activityCode": "string",
    "percentageOfShares": 0,
    "role": "string",
    "countryCode": "string",
    "address": {
      "buildingDetails": "string",
      "street": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string",
      "type": "string",
      "description": "string"
    }
  }'

Responses

Success

Bodyapplication/json
idstring, (uuid)

Id of the key party

namestring

Name of the key party

firstNamestring

First name of the key party

middleNamestring or null

Middle name of the key party

lastNamestring

Last name of the key party

entityTypestring

Entity type of the key party, i.e. individual, business

keyPartyTypestring

Type of the key party, i.e. director, shareHolder, ubo

genderstring or null

Gender of the key party, i.e. male, female

dateOfBirthstring or null, (date)

Date of birth of the key party

organisationNumberstring or null

Key party organization number

activityCodestring or null

Activity code of the key party

percentageOfSharesnumber or null, (double)

Share percentage of the key party

rolestring or null

Role of the key party

countryCodestring or null

Country code of the key party

addressobject
searchIdstring or null, (uuid)

Search Id of the key party

createdAtstring, (date-time)

Key party created time

createdByIdinteger, (int32)

Id of the user who created the key party

createdBystring

Name of the user who created the key party

modifiedAtstring or null, (date-time)

key party last updated time

modifiedByIdinteger or null, (int32)

Id of the user who last modified the key party

modifiedBystring or null

Name of the user who last modified the key party

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "entityType": "string",
  "keyPartyType": "string",
  "gender": "string",
  "dateOfBirth": "2019-08-24",
  "organisationNumber": "string",
  "activityCode": "string",
  "percentageOfShares": 0,
  "role": "string",
  "countryCode": "string",
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "buildingDetails": "string",
    "street": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "countryCode": "string",
    "type": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdById": 0,
    "createdBy": "string",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "modifiedById": 0,
    "modifiedBy": "string"
  },
  "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string"
}