PUT
/
api
/
v2.1
/
shareholder
/
update
/
{shareholderId}
Update an existing shareholder
curl --request PUT \
  --url https://sandbox.finhub.cloud/api/v2.1/shareholder/update/{shareholderId} \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --data '{
  "organizationId": "<string>",
  "customerId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "dateOfBirth": "2022-03-10T00:00:00.000Z",
  "nationality": "<string>",
  "address": "<string>",
  "city": "<string>",
  "country": "<string>",
  "postalCode": "<string>",
  "sharePercentage": 50,
  "shareholderType": "<string>",
  "isPep": true,
  "isUbo": true,
  "idDocumentType": "<string>",
  "idDocumentNumber": "<string>",
  "idDocumentExpiryDate": "2022-03-10T00:00:00.000Z"
}'
{
  "success": true,
  "message": "<string>",
  "data": "<any>"
}

Headers

X-Forwarded-For
string
required

Forwarded client IP address

User-Agent
string

Client user agent information

X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Path Parameters

shareholderId
string
required

Body

application/json
organizationId
string
required
firstName
string
required
Required string length: 1 - 100
lastName
string
required
Required string length: 1 - 100
email
string
required
phoneNumber
string
required
dateOfBirth
string<date>
required
Example:

"2022-03-10T00:00:00.000Z"

nationality
string
required
address
string
required
city
string
required
country
string
required
postalCode
string
required
sharePercentage
number
required
Required range: 0 <= x <= 100
shareholderType
string
required
idDocumentType
string
required
idDocumentNumber
string
required
idDocumentExpiryDate
string<date>
required
Example:

"2022-03-10T00:00:00.000Z"

customerId
string
isPep
boolean
isUbo
boolean

Response

Shareholder updated successfully

success
boolean
message
string
data
any