Emlpoyee

Good to know: an employee of a counterparty (internal user): can review requests and documents, and make decisions about opening accounts and transferring funds. The employee is linked to a single Counterparty.

Working with employees you have the following features:

Create employee

Update employee

List the of employees per counterparty

Create employee

To create a new employee in the Counterparty you should use this endpoint.

create employees and assign roles if not empty

post

create employees and assign roles if not empty

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Body
branch_guidstringOptional

branch's guid

emailstringOptional

employee's email

namestringOptional

employee's name

paternal_namestringOptional

employee's paternal name

phonestringOptional

employee's phone

rolesstring[]Optional

Roles if not empty assign created employee to roles from list

surnamestringOptional

employee's surname

Responses
200
OK
application/json
post
POST /api/v1/counterparty/{counterparty_guid}/employees HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "branch_guid": "text",
  "email": "text",
  "name": "text",
  "paternal_name": "text",
  "phone": "text",
  "roles": [
    "text"
  ],
  "surname": "text"
}
{
  "employee_guid": "text",
  "verified": true
}

Example of response:

{
    "employee_guid": "d97ad667-d72c-4a93-b27d-568ca53c30c3",  //employee's guid that is used as employee's identifier
    "verified": true
}

After you created an employee they has to be verified via email. Please replace {bank_alias} and {email} in the link accordingly. 

https://backoffice-{bank_alias}-integrate.dcmapis.com/reset-password/?email={email}

It is expected a password is set up by the employee themselves using the verification code sent to their email.

Roles

Good to know: An employee has a set of assigned roles:

  • a role for working with appropriate permissions for endpoints

  • a role to access the branch

  1. A role contains permissions that you need to set for employees.

    • to set an appropriate role while creating an employee you should feel the parameter "roles" in the request body (as it is mentioned above);

    • if you need to change/add/remove role of an employee look How to add a user to a role.

  2. (optional) you may be interested to use branches for segregating employees.

    • to set an appropriate branch role while creating an employee you should feel the parameter "branch_name" in the request body (as it is mentioned above);

    • if you need to change/add/remove the role of an employee take a look atHow to add employee to branch.

Update employee

update employees

put

update employee

Path parameters
counterparty_guidstringRequired

Counterparty GUID

employee_guidstringRequired

Employee GUID

Body
branch_guidstringOptional

the employee's branch

is_disabledbooleanOptional

if you need to disable an employee you should make this parameter true, default it is false

loginstringOptional

the employee's login

namestringOptional

employee's name

paternal_namestringOptional

employee's paternal name

phonestringOptional

employee's phone

surnamestringOptional

employee's surname

Responses
200
OK
application/json
put
PUT /api/v1/counterparty/{counterparty_guid}/employees/{employee_guid} HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "branch_guid": "text",
  "is_disabled": true,
  "login": "text",
  "name": "text",
  "paternal_name": "text",
  "phone": "text",
  "surname": "text"
}
{
  "guid": "text"
}

Note: you can't change employee's login and you must write in the body only the parameters that you want to change.

Example of response:

{
    "guid": "d97ad667-d72c-4a93-b27d-568ca53c30c3"  // employee's identifier for the employee that you updated 
}

List the of employees per counterparty

Get employees

get

Get employees

Path parameters
counterparty_guidstringRequired

Counterparty GUID

Query parameters
guidsstring[]Optional

Employee's GUIDs

loginsstring[]Optional

Employee's logins

namesstring[]Optional

Employee's names

is_disabledbooleanOptional

Include disabled

branch_guidsstring[]Optional

Employee's branch_guids

offsetintegerOptional

Offset

limitintegerOptional

Limit

orderingstring · enumOptional

Ordering

Possible values:
Responses
200
OK
application/json
get
GET /api/v1/counterparty/{counterparty_guid}/employees HTTP/1.1
Host: your_host
Accept: */*

[
  {
    "branch_guid": "text",
    "branch_name": "text",
    "counterparty_guid": "text",
    "created_at": "text",
    "guid": "text",
    "is_disabled": true,
    "login": "text",
    "name": "text",
    "paternal_name": "text",
    "phone": "text",
    "surname": "text",
    "updated_at": "text"
  }
]

In the response you can see the employees of counterparty with their parameters and total amount of employees.

Response example:
 "employees": [
        {
            "guid": "962784a1-932c-4a7c-8890-054eccbe0321",
            "counterparty_guid": "e8fd9c29-24d5-4af4-a6b9-933f59e5023d",
            "login": "[email protected]",
            "name": "NameOfEmployee2",
            "surname": "SurnameOfEmployee2",
            "paternal_name": "",
            "phone": "+123456789",
            "is_disabled": false,
            "branch_name": "TestBranch5",
            "created_at": "2023-07-14T11:18:53.641765Z",
            "updated_at": "2023-07-14T11:18:53.641765Z"
        },
        {
            "guid": "d97ad667-d72c-4a93-b27d-568ca53c30c3",
            "counterparty_guid": "e8fd9c29-24d5-4af4-a6b9-933f59e5023d",
            "login": "[email protected]",
            "name": "NameOfEmployee_2",
            "surname": "SurnameOfEmployee",
            "paternal_name": "NameOfEmployee_2",
            "phone": "",
            "is_disabled": false,
            "branch_name": "",
            "created_at": "2023-07-14T10:32:34.350283Z",
            "updated_at": "2023-07-14T10:34:50.323629Z"
        },

...
    "total": 29
}
PreviousJWT formatNextHow to add a user to a role

Last updated