Remove a person relation from a business customer

DELETE 
/v1/customers/business/:businessUserId/related-persons

Removes a person relation from a business customer, identified by userId + role in the request body.

Pre-approval (PENDING status): Removes from the onboarding data. Post-approval (APPROVED status): Closes the beneficial owner record via banking partner integration.

Removal is blocked if it would violate hard constraints (e.g., removing the last shareholder or representative).

Request

Path Parameters

businessUserId stringrequired

The ID of the business customer

application/json

Body

required

Person relation to remove (userId + role)

userId stringrequired

User ID of the person relation to remove

role stringrequired

Possible values: [REPRESENTATIVE, SHAREHOLDER]

Role to remove for this person

Responses

200

The person relation was successfully removed.

application/json

Schema

Schema

traceId string
message string

data

object

personRelations

object[]

required

Updated list of person relations

Array [

userId stringrequired

User ID of the related person

role stringrequired

Role of the person in the business

ownershipPercentage string

Ownership percentage (present for SHAREHOLDER role)

]

action stringrequired

Possible values: [ADD, UPDATE, REMOVE]

Action that was performed

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "personRelations": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174021",
        "role": "SHAREHOLDER",
        "ownershipPercentage": "51"
      }
    ],
    "action": "ADD"
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...