Director API (V2)

Download OpenAPI specification:Download

Director

Use API methods in the Director Control to execute director related functions in the company. Add a new director. Get or update personal and contact information of an existing director. Fetch a list of directors and know who are, main or secondary directors, including their percentage ownership in the company.

Add Director

Add secondary directors in the company.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

AddDirectorReq

CompanyID
required
integer <int32>

Unique identifier of the company.

Title
integer <int32>

The title of the consumer. It must be from one of the values as - "Mr, Mrs, Miss, Ms, Dr, Sir, Prof, Other". A conditional parameter based on the scheme setting. If the boolean - "IsTtileRequired" - is set as - "true" - then this parameter is required.

1 = Mr
2 = Mrs
3 = Miss
4 = Ms
5 = Dr
6 = Prof
8 = Sir
9 = Other
10 = Master

Enum: "None" "Mr" "Mrs" "Miss" "Ms" "Dr" "Prof" "Rev" "Sir" "Other" "Master"
FirstName
required
string [ 2 .. 50 ] characters

The first name of director.

LastName
required
string [ 2 .. 50 ] characters

The last name of director.

Gender
required
string = 1 characters

The gender of the consumer. M - Male, F-Female, U-Unknown.

DOB
required
string <date-time>

The date of birth of the director.
Format of date is 'yyyy-MM-dd', e.g. 24-May-1960 as 1960-05-24.

Relationship
required
integer <int32> [ 1 .. 32767 ]

Director's relationship with the main director. Relationship is a mandatory field.

Look up values for Relationship

01 = Self

02 = Family

03 = Friend

04 = Colleague

1 = Self
2 = Family
3 = Friend
4 = Colleague

Enum: "None" "Self" "Family" "Friend" "Colleague" "Managed"
PassportNumber
string [ 0 .. 44 ] characters

The passport number of the director. Must be provided as either a 7, 8 or 9-character passport number, or the full 44 characters of the second line of the passport machine-readable zone (MRZ).

The full MRZ is comprised as follows:

Passport number: (1 to 9)

Allowed values: a-z, A-Z,0-9

Passport Number check sum digit: (10)

Allowed values: 0-9

Country Code: (11 to 13)

Allowed values: a-z, A-Z,0-9

Birth Date with Check Sum: (14 to 20)

Allowed values: 0-9

Gender: (21)

Allowed values: M, m, F, f

Expiration date with Checksum: (22 to 28)

Allowed values: 0-9

Passport Number: (28 to 42)

Allowed values: a-z, A-Z ,0-9

PassportChecksum1: (43)

Allowed values: a-z, A-Z,0-9

PassportChecksum2: (44)

Allowed values: 0-9

PassportExpiryDate
string <date-time>

The date of expiry of the director's passport. If PassportNumber is provided, then PassportExpiryDate must be passed along with that.
Format for date must be 'yyyy-MM-ddTHH:mm:ss.fff',
e.g. '2018-05-24T10:27:26.325' represents 24-May-2018 10:27:26.325.

DrivingLicenceNumber
string [ 0 .. 16 ] characters

Driving license number of the director.

Driving Licence logic :

1 to 16 string value require length of the Driving License.

NUMBER1: (1 to 5)

Allowed values: a-z, A-Z ,0-9

NUMBER2: (6 to 12)

Allowed values: a-z, A-Z ,0-9

NUMBER3: (12 to 14)

Allowed values: a-z, A-Z ,0-9

NUMBER4: (15 to 16)

Allowed values: a-z, A-Z ,0-9

NationalIDCardLine1
string

The information in the first line of the consumer's National identity card. If a value is provided it must conform to the following regex: ^[a-zA-Z0-9<]{6,30}$.

NationalIDCardLine2
string

The second line in the national identity card of the director.

Nationality
string [ 0 .. 3 ] characters

Nationality in three-digit ISO 3166-1 numeric code format.

EmailAddress
required
string [ 0 .. 100 ] characters

Email address of the director.

Regex : ^(([\w-+]+.)+[\w-+.]+|([a-zA-Z]{1}|[\w-+]{2,64}))@((([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]? [0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]? [0-9]{1,2}|25[0-5]|2[0-4][0-9])){1}|(a-zA-Z0-9+.)+[a-zA-Z]{1}[a-zA-Z0-9-]{1,23})$

MobileNumber
string [ 0 .. 15 ] characters

Optional

Mobile number of the director.
MobileNumberCountryCode
string

Country code of mobile number.

IsSkipCardIssuance
boolean

Boolean that identifies if the card is to be issued or not. If "true", then the card will not be issued. If "false", then card will be issued to the director.
Valid values are true or false.

CardDesignCode
string [ 0 .. 8 ] characters

Unique identifier of the card design.

CardLine4Data
string [ 0 .. 21 ] characters

If card design supports "Free Text" for 4th line, then CardLine4Data must be specified.

CardLine5Data
string [ 0 .. 21 ] characters

If card design supports "Free Text" for 5th line, then CardLine5Data must be specified.

IsLoginRequired
boolean

Boolean that identifies if the login is to be created for director. If "true" then login is created. If "false" then login will not be created.
Valid values are true or false.

object (AddressReq)
object (AddressReq)
LivedAtCurrentAddressInMonth
integer <int32>

Number of months the director has lived at current address in month.

EmployeeNumber
string [ 0 .. 30 ] characters

Unique identifier of the director.

IsUBO
boolean

Gets or sets IsUBO in the company.
Valid values are true or false.

SharePercent
integer <int32>

The percentage of ownership in the company.

PersonalIdentificationNumber
string

Lithuania Residents Person Code (mandatory for Lithuanian consumers).

DirectorRequestReference
string [ 0 .. 50 ] characters

DirectorRequestReference number is provided by API client in API request for tracking/auditing purpose of actions performed for Director at Solaris platform.

PersonID
string [ 0 .. 100 ] characters

CRR PersonID

BusinessID
string [ 0 .. 500 ] characters

CRR BusinessID

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/Director/AddDirector
Request samples
application/json
{
  • "CompanyID": 20365,
  • "Title": 1,
  • "FirstName": "FirstExample",
  • "LastName": "SecoundExample",
  • "Gender": "M",
  • "DOB": "2021-08-11T13:02:58.9236748+05:30",
  • "Relationship": 1,
  • "PassportNumber": "123654789",
  • "PassportExpiryDate": "2021-08-11T13:02:58.924674+05:30",
  • "DrivingLicenceNumber": "1321313214",
  • "NationalIDCardLine1": "",
  • "NationalIDCardLine2": "",
  • "Nationality": "",
  • "EmailAddress": "someemail@example.com",
  • "MobileNumber": "97269654789",
  • "MobileNumberCountryCode": "91",
  • "IsSkipCardIssuance": true,
  • "CardDesignCode": "",
  • "CardLine4Data": "",
  • "CardLine5Data": "",
  • "IsLoginRequired": false,
  • "CurrentAddress": {
    },
  • "PreviousAddress": {
    },
  • "LivedAtCurrentAddressInMonth": 25,
  • "EmployeeNumber": "",
  • "IsUBO": true,
  • "SharePercent": 0,
  • "PersonalIdentificationNumber": "",
  • "DirectorRequestReference": "string",
  • "PersonID": "string",
  • "BusinessID": "string",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DirectorID": 76126,
  • "ConsumerID": 0,
  • "DirectorRequestReference": "string",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Director

Returns name, address, national ID, gender, address, mobile number and email ID of specified director(s) in the company

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

GetSpecificDirectorReq

DirectorID
required
integer <int32>

Unique identifier fo the director.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/Director/GetSpecificDirector
Request samples
application/json
{
  • "DirectorID": 1277,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DirectorRes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Directors

Returns list of directors of the company.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListDirectorsReq

CompanyID
required
integer <int32>

Unique identifier of the company.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/Director/ListDirectors
Request samples
application/json
{
  • "CompanyID": 20365,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DirectorResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Director Contact Details

Changes director's contact detail like mobile number, address and email address.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

update director contact detail request

DirectorID
required
integer <int32>

Unique identifier of the director.

EmailAddress
string [ 0 .. 100 ] characters

Email address of director.

Regex : ^(([\w-+]+.)+[\w-+.]+|([a-zA-Z]{1}|[\w-+]{2,64}))@((([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]? [0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]?[0-9]{1,2}|25[0-5]|2[0-4][0-9]).([0-1]? [0-9]{1,2}|25[0-5]|2[0-4][0-9])){1}|(a-zA-Z0-9+.)+[a-zA-Z]{1}[a-zA-Z0-9-]{1,23})$

MobileNumber
string [ 0 .. 50 ] characters

Mobile number of the director.

MobileNumberCountryCode
string [ 0 .. 5 ] characters

Country code for mobile number.

object (AddressReq)
ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/Director/UpdateDirectorContactDetails
Request samples
application/json
{
  • "DirectorID": 76141,
  • "EmailAddress": "someemail@example.com",
  • "MobileNumber": "9876543210",
  • "MobileNumberCountryCode": "44",
  • "Address": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Director Details

Updates director's personal information.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

Update director request detail

DirectorID
required
integer <int32>

Unique identifier of the director.

Title
integer <int32>

The title of the director. If the setting "IsTitleRequired" in the scheme is set as true then this parameter is required.

1 = Mr
2 = Mrs
3 = Miss
4 = Ms
5 = Dr
6 = Prof
8 = Sir
9 = Other
10 = Master

Enum: "None" "Mr" "Mrs" "Miss" "Ms" "Dr" "Prof" "Rev" "Sir" "Other" "Master"
FirstName
string [ 0 .. 50 ] characters

The first name of the director.

LastName
string [ 0 .. 50 ] characters

The last name of the director.

Gender
string [ 0 .. 1 ] characters

Gender of the director. "M" - Male, "F"- Female, "U"- Unknown.

Default value "U"- Unknown.

DOB
string <date-time>

Date of birth of director.
Format of date is 'yyyy-MM-dd', e.g. 24-May-1960 as 1960-05-24.

SharePercent
integer <int32>

The percentage of ownership in the company.

PersonalIdentificationNumber
string

Lithuania Residents Person Code (mandatory for Lithuanian consumers).

IsUBO
boolean

Gets or sets IsUBO in the company.
Valid values are true or false.

Nationality
string [ 0 .. 3 ] characters

The nationality of the consumer in three-digit ISO 3166-1 numeric code format.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/Director/UpdateDirectorDetails
Request samples
application/json
{
  • "DirectorID": 76141,
  • "Title": 1,
  • "FirstName": "Abelson",
  • "LastName": "Hal",
  • "Gender": "M",
  • "DOB": "2009-08-06T00:00:00",
  • "SharePercent": 0,
  • "PersonalIdentificationNumber": "string",
  • "IsUBO": true,
  • "Nationality": "str",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}
Solaris is the brand name for the regulated entities Contis Financial Services Ltd and UAB „Finansinės paslaugos „Contis“, which are part of the Solaris Group.