Update Directors

Adds directors to a business (entity) client through the update endpoint. Through this gateway route elements cannot carry an id, so existing director links are never updated: every element is added as a new director link. Each element either names an existing person client (clientId) or carries the details of a new person who is created on the fly.

PUT /core/director/{clientId}

Path Parameter

Field Name	Type	Required	Description
`clientId`	integer	TRUE	Business client the directors belong to.

Request Body

Field Name	Type	Required	Description
`directors`	array	TRUE	One element per director.
`directors[].clientId`	integer	FALSE	Existing person client. When omitted a new person is created from the fields below.
`directors[].officeId`	string	FALSE	Office of the new person (required for new persons).
`directors[].firstname` / `lastname`	string	FALSE	Name of the new person.
`directors[].emailAddress` / `mobileNo`	string	FALSE	Contact details.
`directors[].externalId`	string	FALSE	BVN of the person.
`directors[].nin`	string	FALSE	NIN of the person.
`directors[].dateOfBirth`	string	FALSE	dd-MM-yyyy.
`directors[].genderId`	integer	FALSE	Gender code value id.
`directors[].submittedOnDate`	string	FALSE	dd-MM-yyyy.
`directors[].address`	array	FALSE	Items of `{addressTypeId, addressLine1}`.

Response

Field Name	Type	Description
`clientId`	integer	The business client the directors were added to.

The remaining response fields (officeId, firstname, ...) are always null; they are not populated.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Path Params

Body Params application/json

Example

{
  "directors": [
    {
      "clientId": 102
    },
    {
      "officeId": "1",
      "firstname": "Bola",
      "lastname": "Sample",
      "emailAddress": "bola@example.com",
      "mobileNo": "08000000001",
      "externalId": "22000000002",
      "nin": "10000000002",
      "dateOfBirth": "02-02-1985",
      "genderId": 1,
      "submittedOnDate": "01-06-2025",
      "address": [
        {
          "addressTypeId": "81",
          "addressLine1": "5 Sample Road"
        }
      ]
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "clientId": 101,
  "officeId": null,
  "firstname": null,
  "lastname": null,
  "emailAddress": null,
  "mobileNo": null,
  "externalId": null,
  "nin": null,
  "dateFormat": null,
  "locale": null,
  "submittedOnDate": null,
  "legalFormId": null
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Update Directors