Skip to main content
GET
https://sandbox.finhub.cloud
/
api
/
v2.1
/
customer
/
organization
/
{organizationId}
/
directors
Organization Directors API
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/directors \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "dateOfBirth": "<string>",
  "nationality": "<string>",
  "role": "<string>",
  "appointedDate": "<string>",
  "address": {}
}
'
{
  "success": true,
  "data": {
    "directors": [
      {
        "directorId": "dir_12345",
        "firstName": "John",
        "lastName": "Director",
        "email": "[email protected]",
        "role": "CEO",
        "appointedDate": "2020-01-15",
        "status": "ACTIVE"
      }
    ]
  }
}

Organization Directors API

APIs for managing directors of business organizations.
Base URL: https://sandbox.finhub.cloud

Available Operations

List Directors

GET /directors

Add Director

POST /directors

Remove Director

DELETE /directors/{id}

List Directors

Retrieves all directors for an organization.
For complete details on authentication and headers, refer to the Standard HTTP Headers reference documentation.

Request

organizationId
string
required
Organization identifier
Authorization
string
required
Bearer token for authentication
X-Tenant-ID
string
required
Tenant identifier

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/directors" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "directors": [
      {
        "directorId": "dir_12345",
        "firstName": "John",
        "lastName": "Director",
        "email": "[email protected]",
        "role": "CEO",
        "appointedDate": "2020-01-15",
        "status": "ACTIVE"
      }
    ]
  }
}

Add Director

Adds a new director to the organization (requires ADMIN role).

Request

organizationId
string
required
Organization identifier
firstName
string
required
Director’s first name
lastName
string
required
Director’s last name
email
string
required
Director’s email address
dateOfBirth
string
required
Date of birth (YYYY-MM-DD)
nationality
string
required
Two-letter country code
role
string
required
Director role (CEO, CFO, CTO, etc.)
appointedDate
string
required
Appointment date (YYYY-MM-DD)
address
object
Director’s address

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/directors" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Executive",
    "email": "[email protected]",
    "dateOfBirth": "1975-06-20",
    "nationality": "DE",
    "role": "CFO",
    "appointedDate": "2024-01-15",
    "address": {
      "street": "456 Director Lane",
      "city": "Munich",
      "postalCode": "80331",
      "country": "DE"
    }
  }'
{
  "success": true,
  "data": {
    "directorId": "dir_67890",
    "status": "ACTIVE",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Remove Director

Removes a director from the organization (requires ADMIN role).

Code Examples

curl -X DELETE "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/directors/dir_67890" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "directorId": "dir_67890",
    "status": "REMOVED"
  }
}

Response Codes

CodeDescription
200Directors retrieved successfully
201Director added successfully
204Director removed successfully
400Invalid request data
403Insufficient permissions
404Organization or director not found
500Internal server error

API Schema Reference

For the complete OpenAPI schema specification, see the API Schema Mapping document.