Replace Beneficial Owner

Overwrite an existing beneficial owner.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT
Request
path Parameters
merchantId
required
string
ownerId
required
string

Identifier of beneficial owner

Request Body schema: application/json
required
title
required
string

Title, in relation to the business

roles
required
Array of strings (Role) non-empty

Roles of the beneficial owner.

Items Enum: "Executive" "Owner" "Director"
givenName
required
string
middleName
string
familyName
required
string
dateOfBirth
required
string <date>

Date of birth in ISO-8601

required
object (LimeAddress)
emailAddress
required
string
phoneNumber
required
string

Phone number in E164 format, eg.+61400000000

object (Passport)
object (DriverLicence)
required
object (VerificationDocs)
Responses
200
400
401
403
404
405
406
409
422
429
500
503
put/merchants/{merchantId}/owners/{ownerId}
Request samples
application/json
{
  • "title": "string",
  • "roles": [
    ],
  • "givenName": "string",
  • "middleName": "string",
  • "familyName": "string",
  • "dateOfBirth": "1970-08-18",
  • "address": {
    },
  • "emailAddress": "lucy.diamond@star.com",
  • "phoneNumber": "+61401234567",
  • "passport": {
    },
  • "driverLicence": {
    },
  • "verificationDocs": {
    }
}
Response samples
application/json
{
  • "ownerId": "pson_Zz6SOf8bIUK88SS6",
  • "profile": {
    },
  • "verificationResult": {
    },
  • "isDeletable": true
}
Copyright © April Solutions 2023. All right reserved.