Update a beneficial owner

put

https://api.everee.com/integration/v1/partner/companies/{companyId}/beneficial-owners/{ownerId}

Replace a beneficial owner's details on a draft company.

Use this endpoint to change a beneficial owner. It replaces the owner's details, so send every field. The rules are the same as in Add a beneficial owner.

📘
Part of People and ownership. For how this fits into onboarding, see the guide: Collecting company information: the people.

To fix only an owner's phone or email, including after signing or submitting, use Correct a person's contact details.

When you can call this

Only while the onboarding is a DRAFT and the contract documents haven't been signed. Otherwise it returns 409.

Errors

Status	Meaning
`400`	`identity` is invalid, an `ENTITY` owner is missing required details, or ownership would total more than 100%.
`401`	The API key is missing, malformed or expired.
`404`	The company or the owner wasn't found.
`409`	The onboarding is no longer a `DRAFT`, or the contract has been signed.
`422`	A required field is missing or malformed.

Path Params

companyId

integer

required

The company's ID, as returned when the company was created.

ownerId

integer

required

The beneficial owner's ID, which is the id in the owner's record (the number after owner- in personRef).

Body Params

firstName

string

required

lastName

string

required

title

string

Job title or role at the company.

string

required

Email address. The person's identity-verification link is sent here.

phone

string

required

10-digit US phone number. Formatting characters are allowed. The person's identity-verification link is sent here.

identity

object

required

The details Everee uses to verify the person.

ownerType

string

enum

Whether the owner is an individual or a legal entity. Defaults to PERSON. For an ENTITY, the person fields describe the individual who represents the entity.

Allowed:

ownershipPercentage

number

required

25 to 100

The percentage of the company the owner holds, from 25 to 100.

entityName

string

The entity's name. Required for an ENTITY owner.

entityEin

string

The entity's 9-digit EIN. Required for an ENTITY owner.

representativeOwnershipPercentage

number

0.01 to 100

The percentage of the entity the representative owns, from 0.01 to 100. Required for an ENTITY owner.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

When you can call this

Errors

200The updated beneficial owner.

400identity is invalid, an ENTITY owner is missing required details, or the ownership percentages would add up to more than 100%.

401The API key is missing, malformed or expired.

404No company with this ID belongs to your partner account, or the company has no beneficial owner with this ID.

409The company's onboarding is no longer a draft, or its contract has already been signed, so this information can no longer be changed.

422The request body is invalid. For example, a required field is missing or a value is malformed.