Add employee (alias)

curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/employee \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <user-agent>' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --header 'deviceId: <deviceid>' \
  --header 'platform: <platform>' \
  --data '
{
  "person": {
    "fullName": "Jane Compliance",
    "email": "compliance.1773494456556@acmecorp.com",
    "firstName": "Jane",
    "lastName": "Compliance",
    "middleName": "<string>",
    "dateOfBirth": "1990-03-25",
    "nationality": "Lithuania",
    "gender": "1",
    "phoneNumber": "+37068076104",
    "countryCode": "<string>",
    "names": [
      {
        "value": "<string>",
        "type": "<string>"
      }
    ],
    "contacts": [
      {
        "type": "<string>",
        "value": "<string>",
        "isPrimary": true
      }
    ],
    "addresses": [
      {
        "id": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postalCode": "<string>",
        "addressType": "<string>"
      }
    ]
  },
  "position": "COMPLIANCE_OFFICER",
  "roles": [
    "COMPLIANCE_OFFICER",
    "TRANSACTION_APPROVER",
    "EMPLOYEE",
    "ADMIN_USER"
  ],
  "responsibility": "Compliance Management",
  "department": "Compliance",
  "organizationRole": "ACCOUNT_OWNER",
  "status": "ACTIVE",
  "sharePercentage": 123,
  "ultimatePercentage": 123,
  "groupId": "<string>",
  "documentId": "<string>"
}
'

{
  "success": true,
  "data": {
    "employees": [
      {
        "employeeId": "emp_12345",
        "firstName": "Alice",
        "lastName": "Worker",
        "email": "alice.worker@acme.com",
        "department": "Finance",
        "role": "ACCOUNTANT",
        "status": "ACTIVE",
        "hiredDate": "2023-03-15"
      }
    ],
    "pagination": {
      "total": 25,
      "page": 0,
      "size": 20
    }
  }
}

POST

api

v2.1

customer

organization

{organizationId}

employee

Add employee (alias)

curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/employee \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <user-agent>' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --header 'deviceId: <deviceid>' \
  --header 'platform: <platform>' \
  --data '
{
  "person": {
    "fullName": "Jane Compliance",
    "email": "compliance.1773494456556@acmecorp.com",
    "firstName": "Jane",
    "lastName": "Compliance",
    "middleName": "<string>",
    "dateOfBirth": "1990-03-25",
    "nationality": "Lithuania",
    "gender": "1",
    "phoneNumber": "+37068076104",
    "countryCode": "<string>",
    "names": [
      {
        "value": "<string>",
        "type": "<string>"
      }
    ],
    "contacts": [
      {
        "type": "<string>",
        "value": "<string>",
        "isPrimary": true
      }
    ],
    "addresses": [
      {
        "id": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postalCode": "<string>",
        "addressType": "<string>"
      }
    ]
  },
  "position": "COMPLIANCE_OFFICER",
  "roles": [
    "COMPLIANCE_OFFICER",
    "TRANSACTION_APPROVER",
    "EMPLOYEE",
    "ADMIN_USER"
  ],
  "responsibility": "Compliance Management",
  "department": "Compliance",
  "organizationRole": "ACCOUNT_OWNER",
  "status": "ACTIVE",
  "sharePercentage": 123,
  "ultimatePercentage": 123,
  "groupId": "<string>",
  "documentId": "<string>"
}
'

{
  "success": true,
  "data": {
    "employees": [
      {
        "employeeId": "emp_12345",
        "firstName": "Alice",
        "lastName": "Worker",
        "email": "alice.worker@acme.com",
        "department": "Finance",
        "role": "ACCOUNTANT",
        "status": "ACTIVE",
        "hiredDate": "2023-03-15"
      }
    ],
    "pagination": {
      "total": 25,
      "page": 0,
      "size": 20
    }
  }
}

Organization Employees API

APIs for managing employees and their roles within business organizations.

Base URL: https://sandbox.finhub.cloud

Available Operations

List Employees

GET /employees

Add Employee

POST /employees

Update Roles

PUT /employees/{id}/roles

List Employees

Retrieves all employees for an organization with their assigned roles.

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

department

string

Filter by department

role

string

Filter by role

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/employees?department=Finance" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "X-Forwarded-From: e2e-test" \
  -H "User-Agent: YourApp/1.0" \
  -H "platform: web" \
  -H "deviceId: 356938035643809"

{
  "success": true,
  "data": {
    "employees": [
      {
        "employeeId": "emp_12345",
        "firstName": "Alice",
        "lastName": "Worker",
        "email": "alice.worker@acme.com",
        "department": "Finance",
        "role": "ACCOUNTANT",
        "status": "ACTIVE",
        "hiredDate": "2023-03-15"
      }
    ],
    "pagination": {
      "total": 25,
      "page": 0,
      "size": 20
    }
  }
}

Add Employee

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

Request

organizationId

string

required

Organization identifier

person

object

required

Employee personal information

Show person properties

firstName

string

required

Employee first name

lastName

string

required

Employee last name

string

required

Employee email address

phoneNumber

string

Employee phone number (E.164 format)Example: "+37068076104"

dateOfBirth

string

Date of birth (YYYY-MM-DD)Example: "1990-03-25"

nationality

string

NationalityExample: "Lithuania"

gender

string

Gender identifierExample: "1"

fullName

string

Full display nameExample: "Jane Compliance"

position

string

required

Employee position within the organizationExample: "COMPLIANCE_OFFICER"

roles

string[]

required

Array of role identifiersValid Roles:

COMPLIANCE_OFFICER
TRANSACTION_APPROVER
EMPLOYEE
ADMIN_USER

Example: ["COMPLIANCE_OFFICER", "TRANSACTION_APPROVER", "EMPLOYEE", "ADMIN_USER"]

department

string

Department nameExample: "Compliance"

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/employee" \
  -H "Accept: application/json, text/plain, */*" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "X-Forwarded-From: e2e-test" \
  -H "platform: web" \
  -H "deviceId: 356938035643809" \
  -d '{
    "person": {
      "firstName": "Jane",
      "lastName": "Compliance",
      "email": "compliance@acmecorp.com",
      "phoneNumber": "+37068076104",
      "dateOfBirth": "1990-03-25",
      "nationality": "Lithuania",
      "gender": "1",
      "fullName": "Jane Compliance"
    },
    "position": "COMPLIANCE_OFFICER",
    "roles": ["COMPLIANCE_OFFICER", "TRANSACTION_APPROVER", "EMPLOYEE", "ADMIN_USER"],
    "department": "Compliance"
  }'

{
  "success": true,
  "data": {
    "employeeId": "emp_67890",
    "userId": "user_11111",
    "status": "PENDING_ACTIVATION",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Remove Employee

Removes an employee from the organization.

Code Examples

curl -X DELETE "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/employees/emp_67890" \
  -H "Accept: application/json, text/plain, */*" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "X-Forwarded-From: e2e-test" \
  -H "platform: web" \
  -H "deviceId: 356938035643809"

Employee Roles

Role	Description
`ADMIN`	Full organization access
`OPERATOR`	Transaction operations
`ACCOUNTANT`	Financial reporting
`VIEWER`	Read-only access

Response Codes

Code	Description
`200`	Employees retrieved/updated successfully
`201`	Employee added successfully
`204`	Employee removed successfully
`400`	Invalid request data or role validation failed
`403`	Access denied
`404`	Organization not found
`500`	Internal server error

API Schema Reference

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

Standard Headers

Complete HTTP headers reference

Organization Registration

Directors

Manage organization directors

Shareholders

Manage organization shareholders

Headers

X-Organization-ID

string

Organization identifier header (must match path)

Example:

"b4c3d4e7-f8a9-0123-b4c5-d6e7f8a9012b"

User-Agent

string

required

Browser user agent

Example:

"Mozilla/5.0"

X-Forwarded-For

string

required

Client/application Ip address

Example:

"192.168.0.1"

X-Forwarded-From

string

required

Client/application identifier for request source tracking

Example:

"playground"

X-Tenant-ID

string

required

Tenant identifier

Example:

"97e7ff29-15f3-49ef-9681-3bbfcce4f6cd"

X-User-Roles

string

Comma-separated user roles

Example:

"ADMIN_USER,COMPLIANCE_OFFICER"

platform

string

required

Client platform identifier. Also accepted as sec-ch-ua-platform

Example:

"web"

deviceId

string

required

Device identifier

Example:

"e2e-test-device"

Authorization

string

required

Bearer token from admin or customer session creation

Example:

"Bearer <token>"

Path Parameters

organizationId

string

required

Organization identifier (UUID)

Example:

"b4c3d4e7-f8a9-0123-b4c5-d6e7f8a9012b"

Body

application/json

person

object

required

Show child attributes

position

string

required

Example:

"COMPLIANCE_OFFICER"

roles

string[]

required

Example:

[
  "COMPLIANCE_OFFICER",
  "TRANSACTION_APPROVER",
  "EMPLOYEE",
  "ADMIN_USER"
]

responsibility

string

Example:

"Compliance Management"

department

string

Example:

"Compliance"

organizationRole

string

Example:

"ACCOUNT_OWNER"

status

string

Example:

"ACTIVE"

ultimatePercentage

number<float>

groupId

string

documentId

string

Response

200 - application/json

Employee added successfully

Standard API response wrapper used by all endpoints

code

integer

HTTP status code

Example:

200

data

object

Response from adding an employee to an organization

Show child attributes

message

string

Human-readable status message

Example:

"Success"

Organization Directors API Organization Shareholders API

⌘I

Client Categories

Product Suite

Service Models

CoreX Service Model

API Service Model

Hybrid Service Model

Organization Employees API

Organization Employees API

Available Operations

List Employees

Add Employee

Update Roles

List Employees

Request

Code Examples

Add Employee

Request

Code Examples

Remove Employee

Code Examples

Employee Roles

Response Codes

API Schema Reference

Standard Headers

Organization Registration

Directors

Shareholders

Headers

Path Parameters

Body

Response

Client Categories

Product Suite

Service Models

CoreX Service Model

API Service Model

Hybrid Service Model

​Organization Employees API

​Available Operations

List Employees

Add Employee

Update Roles

​List Employees

​Request

​Code Examples

​Add Employee

​Request

​Code Examples

​Remove Employee

​Code Examples

​Employee Roles

​Response Codes

​API Schema Reference

​Related Endpoints

Standard Headers

Organization Registration

Directors

Shareholders

Headers

Path Parameters

Body

Response

Organization Employees API

Available Operations

List Employees

Request

Code Examples

Add Employee

Request

Code Examples

Remove Employee

Code Examples

Employee Roles

Response Codes

API Schema Reference

Related Endpoints