Update a related person

patch

https://api.dev.cfx.to/v1/organization/{organizationId}/related-person/{relatedPersonId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

The unique Organization ID provided upon organization registration

relatedPersonId

string

required

The unique related person ID

Body Params

type

string

enum

Allowed:

firstName

string

middleName

string

lastName

string

countryOfResidence

string

alpha-2 ISO-3166-1

string

length ≥ 1

phone

string

E.164 format

dateOfBirth

string

yyyy-MM-dd

address

object

taxId

string

The person's own tax identification number — SSN or ITIN for a US person. Not the organization's tax ID.

isBeneficialOwner

boolean

CONTROL only: this person is also a beneficial owner. Requires ownershipPercent above 0 and at most 100. Send one CONTROL entry with this flag rather than a second BENEFICIAL_OWNER entry for the same person.

ownershipPercent

number

Beneficial ownership stake (0-100). For BENEFICIAL_OWNER, or a CONTROL person with isBeneficialOwner.

sharesAllocated

number

title

string

Headers

Idempotency-Key

string

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Default Response

401The access to this resource has been denied

403The credentials are valid but the caller is not permitted to transact

404The resource was not found

409A duplicate request with this idempotency key is already in progress

422Another request with this idempotency key was made using a different body

defaultCatch-all error response for any unexpected internal errors