Correct a company key party

curl --request PUT \
  --url https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/key-parties/entity/{keyPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalKeyPartyId": "holdco-test-0003",
  "entityName": "Acme Holdings Test plc",
  "entityType": "other",
  "address": {
    "street": "New Street",
    "city": "London",
    "countryCode": "GB",
    "postalCode": "EC1A 1BB"
  }
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalKeyPartyId: 'holdco-test-0003',
    entityName: 'Acme Holdings Test plc',
    entityType: 'other',
    address: {
      street: 'New Street',
      city: 'London',
      countryCode: 'GB',
      postalCode: 'EC1A 1BB'
    }
  })
};

fetch('https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/key-parties/entity/{keyPartyId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/key-parties/entity/{keyPartyId}"

payload = {
    "externalKeyPartyId": "holdco-test-0003",
    "entityName": "Acme Holdings Test plc",
    "entityType": "other",
    "address": {
        "street": "New Street",
        "city": "London",
        "countryCode": "GB",
        "postalCode": "EC1A 1BB"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "keyPartyId": "6aca84eceb86373b87dca9e4",
  "externalKeyPartyId": "holdco-test-0003",
  "investorId": "6aca84e5dc49fe8369dd1da4",
  "signerType": "entity",
  "uboOwning": "none",
  "details": {
    "entityName": "Acme Holdings Test plc",
    "entityType": "other",
    "address": {
      "street": "New Street",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "EC1A 1BB"
    }
  }
}

Key parties

Correct a company key party

Replaces a company key party. The correction is stored by Securitize and reaches verification with the entity’s next submit.

Full replacement, not a merge. Any optional field you omit is cleared (doingBusinessAs, email, taxId + taxCountry) and uboOwning falls back to none. Send the full record every time.

externalKeyPartyId must be the one this key party was created with — a different value answers 422.

Changing entityType changes which documents are expected: read the new checklist in GET /investors/{investorId}/key-parties.

A person key party addressed through this route answers 404 key_party_not_found; correct it with PUT /investors/{investorId}/key-parties/individual/{keyPartyId}.

PUT

investors

{investorId}

key-parties

entity

{keyPartyId}

Correct a company key party

curl --request PUT \
  --url https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/key-parties/entity/{keyPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalKeyPartyId": "holdco-test-0003",
  "entityName": "Acme Holdings Test plc",
  "entityType": "other",
  "address": {
    "street": "New Street",
    "city": "London",
    "countryCode": "GB",
    "postalCode": "EC1A 1BB"
  }
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    externalKeyPartyId: 'holdco-test-0003',
    entityName: 'Acme Holdings Test plc',
    entityType: 'other',
    address: {
      street: 'New Street',
      city: 'London',
      countryCode: 'GB',
      postalCode: 'EC1A 1BB'
    }
  })
};

fetch('https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/key-parties/entity/{keyPartyId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/key-parties/entity/{keyPartyId}"

payload = {
    "externalKeyPartyId": "holdco-test-0003",
    "entityName": "Acme Holdings Test plc",
    "entityType": "other",
    "address": {
        "street": "New Street",
        "city": "London",
        "countryCode": "GB",
        "postalCode": "EC1A 1BB"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "keyPartyId": "6aca84eceb86373b87dca9e4",
  "externalKeyPartyId": "holdco-test-0003",
  "investorId": "6aca84e5dc49fe8369dd1da4",
  "signerType": "entity",
  "uboOwning": "none",
  "details": {
    "entityName": "Acme Holdings Test plc",
    "entityType": "other",
    "address": {
      "street": "New Street",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "EC1A 1BB"
    }
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL (the host root, not under the base URL), with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed. The token identifies your partner account, so you never send a partner id, and every record you create is scoped to you.

Path Parameters

investorId

string

required

The investorId Securitize returned when you created the investor. Not your externalInvestorId.

Identifier assigned by Securitize, opaque and specific to your partner account. Store it as an opaque string.

Minimum string length: 1

Example:

"6aca84e5dc49fe8369dd1da4"

keyPartyId

string

required

The keyPartyId Securitize returned when you created the key party. Identifier assigned by Securitize, opaque and specific to your partner account. Store it as an opaque string.

Minimum string length: 1

Example:

"6aca84e5dc49fe8369dd1da4"

Body

application/json

A company key party (corporate shareholder). The same body creates it and, on PUT, replaces it in full: an optional field you omit on PUT is cleared.

externalKeyPartyId

string

required

Your own id for this company, unique within the entity. Fixed at create.

Pattern: ^[A-Za-z0-9._-]{1,128}$

Example:

"ent-test-0001"

entityName

string

required

Registered legal name. Letters, digits, spaces and . ' & # / , -.

Required string length: 1 - 200

Pattern: ^[a-zA-Z0-9\s.'&#/,-]+$

entityType

enum<string>

required

The legal form of a company key party. It decides which documents that key party must have on file before the entity can be submitted.

Available options:

revocable-trust,

irrevocable-trust,

limited-partnership/general-partnership,

non-profit-foundation,

for-profit-foundation,

fund,

llc,

corporation,

other

address

object

required

Registered address. Its country feeds the entity's risk level.

Show child attributes

signerType

enum<string>

Optional. When present it must be entity; individual answers 422.

Available options:

entity

doingBusinessAs

string

Trading name, when it differs from the legal name. Same characters as entityName.

Maximum string length: 200

Pattern: ^[a-zA-Z0-9\s.'&#/,-]*$

string<email>

Contact email. Stored in lower case.

taxId

string

Tax identifier. Letters, digits, spaces and -. Send it together with taxCountry or not at all; one without the other answers 422.

Maximum string length: 50

Pattern: ^[a-zA-Z0-9\s-]*$

taxCountry

string

Country of the tax identifier. Required when taxId is sent.

Pattern: ^[A-Za-z]{2}$

Example:

"US"

uboOwning

enum<string>

default:none

Ownership band of the key party in the entity: none, 10+ (10 % or more) or 25+ (25 % or more). Recorded for compliance reporting. Defaults to none when omitted, including on a correction.

Available options:

none,

10+,

25+

Response

Corrected. Omitted optional fields are absent; uboOwning reads its default.

A company key party. It has no status and no person fields.

keyPartyId

string

required

Securitize's id for this key party. Store it.

Minimum string length: 1

Example:

"6aca84e5dc49fe8369dd1da4"

externalKeyPartyId

string

required

Your own id for this key party.

Pattern: ^[A-Za-z0-9._-]{1,128}$

Example:

"ent-test-0001"

investorId

string

required

The entity this key party belongs to.

Minimum string length: 1

Example:

"6aca84e5dc49fe8369dd1da4"

signerType

enum<string>

required

The kind of key party.

Available options:

entity

uboOwning

enum<string>

default:none

required

Ownership band of the key party in the entity: none, 10+ (10 % or more) or 25+ (25 % or more). Recorded for compliance reporting. Defaults to none when omitted, including on a correction.

Available options:

none,

10+,

25+

details

object

required

The company data Securitize holds for a company key party.

Show child attributes

Get started

Guides

Concepts

Help

API reference

Correct a company key party

Authorizations

Path Parameters

Body

Response