Skip to main content
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 'Content-Type: application/json' \
  --data '
{
  "person": {
    "fullName": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "dateOfBirth": "<string>",
    "nationality": "<string>",
    "gender": "<string>",
    "phoneNumber": "<string>",
    "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": "<string>",
  "responsibility": "<string>",
  "department": "<string>",
  "roles": [
    "<string>"
  ],
  "organizationRole": "<string>",
  "status": "<string>",
  "sharePercentage": 123,
  "ultimatePercentage": 123,
  "groupId": "<string>",
  "documentId": "<string>"
}
'

Headers

X-Organization-ID
string
X-Tenant-ID
string
X-User-Roles
string

Path Parameters

organizationId
string
required

Body

application/json
person
object
position
string
responsibility
string
department
string
roles
string[]
organizationRole
string
status
string
sharePercentage
number<float>
ultimatePercentage
number<float>
groupId
string
documentId
string

Response

200

OK