Download OpenAPI specification:Download
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 secondary directors in the company.
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. |
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.
|
Relationship required | integer <int32> [ 1 .. 32767 ] Director's relationship with the main director. Relationship is a mandatory field. Look up values for 01 = Self 02 = Family 03 = Friend 04 = Colleague
|
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.
|
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: |
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.
|
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 |
CardLine5Data | string [ 0 .. 21 ] characters If card design supports "Free Text" for 5th line, then |
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.
|
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.
|
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. |
OK
Bad Request
Internal Server Error
{- "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": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "PreviousAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "LivedAtCurrentAddressInMonth": 25,
- "EmployeeNumber": "",
- "IsUBO": true,
- "SharePercent": 0,
- "PersonalIdentificationNumber": "",
- "DirectorRequestReference": "string",
- "PersonID": "string",
- "BusinessID": "string",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "DirectorID": 76126,
- "ConsumerID": 0,
- "DirectorRequestReference": "string",
- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Returns name, address, national ID, gender, address, mobile number and email ID of specified director(s) in the company
GetSpecificDirectorReq
OK
Bad Request
Internal Server Error
{- "DirectorID": 1277,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "DirectorRes": {
- "DirectorID": 63741,
- "ConsumerPersonalRes": {
- "Title": "Mr",
- "FirstName": "DirectorFirstName",
- "LastName": "DirectorLastName",
- "Gender": "M",
- "DOB": "1984-12-31T00:00:00",
- "Relationship": 1,
- "PassportNumber": "0321056784915011025M0810050",
- "PassportExpiryDate": "2020-01-01T00:00:00",
- "DrivingLicenceNumber": "",
- "NationalIDCardLine1": "",
- "NationalIDCardLine2": "",
- "Nationality": ""
}, - "ContactRes": {
- "EmailAddress": "darshit.desai@demogroup.com",
- "MobileNumber": "449824320432",
- "MobileNumberCountryCode": "44",
- "MobileNumberISOCountryCode": "",
- "IsMobileVerified": false,
- "AddressRes": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "",
- "District": "North Yorkshire",
- "Country": "UK",
- "Postcode": "BD23 1RL",
- "AddressLine1": "101 South Street",
- "AddressLine2": "Nr. Highland",
- "AddressLine3": "Opp. Fun Park",
- "Region": "North West",
- "Organization": "DemoExample Group",
- "ISOCountryCode": "826"
}
}, - "IsMainDirector": false,
- "SharePercent": 20,
- "IsUBO": false,
- "PersonalIdentificationNumber": "",
- "DirectorRequestReference": "string",
- "ConsumerId": 0
}, - "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Returns list of directors of the company.
ListDirectorsReq
OK
Bad Request
Internal Server Error
{- "CompanyID": 20365,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "DirectorResList": [
- {
- "DirectorID": 63741,
- "ConsumerPersonalRes": {
- "Title": "Mr",
- "FirstName": "DirectorFirstName",
- "LastName": "DirectorLastName",
- "Gender": "M",
- "DOB": "1984-12-31T00:00:00",
- "Relationship": 1,
- "PassportNumber": "0321056784915011025M0810050",
- "PassportExpiryDate": "2020-01-01T00:00:00",
- "DrivingLicenceNumber": "",
- "NationalIDCardLine1": "",
- "NationalIDCardLine2": "",
- "Nationality": ""
}, - "ContactRes": {
- "EmailAddress": "darshit.desai@demogroup.com",
- "MobileNumber": "449824320432",
- "MobileNumberCountryCode": "44",
- "MobileNumberISOCountryCode": "",
- "IsMobileVerified": false,
- "AddressRes": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "",
- "District": "North Yorkshire",
- "Country": "UK",
- "Postcode": "BD23 1RL",
- "AddressLine1": "101 South Street",
- "AddressLine2": "Nr. Highland",
- "AddressLine3": "Opp. Fun Park",
- "Region": "North West",
- "Organization": "DemoExample Group",
- "ISOCountryCode": "826"
}
}, - "IsMainDirector": false,
- "SharePercent": 20,
- "IsUBO": false,
- "PersonalIdentificationNumber": "",
- "DirectorRequestReference": "string",
- "ConsumerId": 0
}
], - "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Changes director's contact detail like mobile number, address and email address.
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. |
OK
Bad Request
Internal Server Error
{- "DirectorID": 76141,
- "EmailAddress": "someemail@example.com",
- "MobileNumber": "9876543210",
- "MobileNumberCountryCode": "44",
- "Address": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Updates director's personal information.
Update director request detail
OK
Bad Request
Internal Server Error
{- "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
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}