Skip to main content
PATCH
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Path Parameters

customerId
string
required

An ID that uniquely identifies a customer resource

Example:

"cus_1234567890abcdef"

id
string
required

An ID that uniquely identifies an associated entity resource

Example:

"asp_1234567890abcdef"

Body

application/json

Updated associated individual data

parentEntityId
string

Parent entity ID for nested ownership. Must reference a BUSINESS associated entity on the same customer.

countryCode
string

Country code (ISO 3166-1 alpha-2)

email
string

Email address

phone
string

Phone number

address
object

Address. Use the nested transliterated field for Latin character versions of non-Latin addresses.

hasOwnership
boolean

Whether this entity is an owner. For an individual with indirect ownership whose percentage is not quantified, omit ownershipPercentage and set this to true to identify them as a beneficial owner.

hasControl
boolean

Has significant control (e.g. CEO, managing member). A control person satisfies the business submission requirement when no individual holds 25% or more effective ownership.

ownershipPercentage
number

Ownership percentage

isSigner
boolean

Has signing authority

isDirector
boolean

Is a director

role
enum<string>

Structured role at the company.

Available options:
CEO,
CFO,
COO,
PRESIDENT,
GENERAL_COUNSEL,
MANAGING_MEMBER,
TREASURER,
OTHER
governmentId
object

Government ID

proofOfAddress
object

Proof of address document (for INDIVIDUAL). Required for recipients using the SWIFT overlay, not for the SWIFT transfer itself. Examples: utility bill, bank statement, lease agreement.

supportingDocuments
object[]

Additional supporting document references for this associated entity.

attestedOwnershipStructureAt
string

Timestamp when ownership structure was attested

relationshipDate
string

Date when the relationship with this entity was established (YYYY-MM-DD)

Example:

"2020-01-15"

firstName
string

First name

lastName
string

Last name

middleName
string

Middle name

nickname
string

Nickname

dateOfBirth
string

Date of birth (YYYY-MM-DD)

taxResidenceCountry
string

Optional. Country of tax residence (ISO 3166-1 alpha-2). Provide only when it differs from nationality; tax ID format validation falls back to nationality when omitted.

Example:

"GB"

taxIdentificationNumber
string

Tax identification number. Validated in the service against the stored nationality and residence, so partial updates that omit countries are still checked.

taxIdentificationDocumentType
string

Tax identification document type when the issuing country supports multiple tax ID types.

Example:

"UTR"

transliteratedFirstName
string

Transliterated first name

transliteratedMiddleName
string

Transliterated middle name

transliteratedLastName
string

Transliterated last name

Response

Associated individual updated successfully

id
string
required

Unique identifier

Example:

"asp_abc123"

createdAt
string
required

Created timestamp

Example:

"2026-01-15T10:30:00Z"

updatedAt
string
required

Last updated timestamp

Example:

"2026-01-15T10:30:00Z"

entityType
enum<string>
required

Type of entity

Available options:
INDIVIDUAL,
BUSINESS
Example:

"BUSINESS"

hasOwnership
boolean
required

Whether this entity is an owner. For an individual with indirect ownership whose percentage is not quantified, omit ownershipPercentage and set this to true to identify them as a beneficial owner.

Example:

true

hasControl
boolean
required

Has significant control (e.g. CEO, managing member). A control person satisfies the business submission requirement when no individual holds 25% or more effective ownership.

Example:

true

parentEntityId
string

Parent entity ID for nested ownership. Use the associated business entity ID returned from the associated entity endpoints when linking a child owner beneath an intermediate business owner.

Example:

"asp_parent123"

details
object

Type-specific details (individual or business)

countryCode
string

Country code (ISO 3166-1 alpha-2)

Example:

"US"

email
string

Email address

Example:

"contact@acmeholdings.com"

phone
string

Phone number

Example:

"+14155551234"

address
object

Address. Use the nested transliterated field for Latin character versions of non-Latin addresses.

ownershipPercentage
number

Ownership percentage

Example:

51

isSigner
boolean

Has signing authority

Example:

false

isDirector
boolean

Is a director

Example:

false

role
enum<string>

Structured role at the company.

Available options:
CEO,
CFO,
COO,
PRESIDENT,
GENERAL_COUNSEL,
MANAGING_MEMBER,
TREASURER,
OTHER
title
string

Custom title at the company.

Example:

"Managing Director"

documents
string[]

Array of document IDs

Example:
attestedOwnershipStructureAt
string

Timestamp when ownership structure was attested

Example:

"2026-01-15T10:30:00Z"

displayName
string

Display name

Example:

"Acme Holdings LLC"

Verification link for UBO KYC. Present on create (when generateVerificationLink is true) and on single entity GET if there is an active/pending verification session.