Business API (V2)

Download OpenAPI specification:Download

Business

Within the Business Controller you can activate a company, set up after registration. Search for a company and view its locations around the world. Change its details, get a list of its transactions and balance in a company’s account. Set or get card spending limits.

Activate Company

Activates 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

The object req information.

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

Success

400

Bad Request

500

Server Error

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

Add Consumers

Add a business consumer with card spend limit for ATM, POS and ecommerce.

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

GetBalanceReq

CompanyID
required
integer <int32>

Unique identifier of the company.

DepartmentID
integer <int32>

Optional

Unique identifier of the department in the company.
IsAuthorizer
boolean

Optional

Boolean that identifies whether to issue or not issue a card to the consumer(s).
Valid values are `true` or `false`.
Title
integer <int32>

Conditional : Mandatory when client defind "title must" in scheme setting.

Title must be from one of the values as - "Mr, Mrs, Miss, Ms, Dr, Sir, Prof, Other".

1 = Mr

2 = Mrs

3 = Miss

4 = Ms

5 = Dr

6 = Prof

8 = Sir

9 = Other



0 = Select
1 = Mr
2 = Mrs
3 = Miss
4 = Ms
5 = Dr
6 = Prof
7 = Rev
8 = Sir
9 = Other
10 = Master
Enum: "Select" "Mr" "Mrs" "Miss" "Ms" "Dr" "Prof" "Rev" "Sir" "Other" "Master"
FirstName
required
string [ 2 .. 50 ] characters

First name of consumer.

LastName
required
string [ 2 .. 50 ] characters

Last name of consumer.

Gender
required
string [ 0 .. 1 ] characters

The gender of the consumer. MUST be from one of the values, "M - Male", "F - Female", "U - Unknown".

DOB
required
string <date-time>

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

JobTitle
string [ 0 .. 30 ] characters

Optional

Job title of the employee (consumer).
ConsumerCode
string [ 0 .. 30 ] characters

Solaris provided unique identifier of the consumer.

Nationality
string [ 0 .. 3 ] characters

Optional

Nationality in three-digit ISO 3166-1 numeric code format.
EmailAddress
required
string [ 0 .. 100 ] characters

Mandatory for Employee/Add method, Optional for Employee/Change Method.

Email address of the company.
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-Z0-9-]{0,1})+\.)+[a-zA-Z]{1}[a-zA-Z0-9-]{1,23})$
MobileNumber
required
string [ 0 .. 50 ] characters

Numeric value of mobile number without ISO country code.

MobileISOCountryCode
required
string [ 1 .. 3 ] characters

ISO country code of mobile.

Landlinenumber
string [ 0 .. 50 ] characters

Optional

Landline number's numeric value without ISO country code.
LandlineISOCountryCode
string [ 0 .. 3 ] characters

Conditional: Mandatory if landline number is specified.

ISO country code for the Landline number.
CardDesignCode
string [ 0 .. 8 ] characters

Unique identifier of the card's design.

CardLine4Data
string

Optional

Additional Data-1 to be printed on Card if card design supports line 4 "Free Text".
CardLine5Data
string

Optional

Additional Data-2 to be printed on Card if card design support line 5 "Free Text"
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).

object (ConsumerCardLimitReq)

ConsumerCardLimitReq

IsSkipCardIssuance
boolean

Gets or sets IsSkipCardIssuance.
Valid values are true or false.

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

Success

400

Bad Request

500

Server Error

post/Business/AddConsumers
Request samples
application/json
{
  • "CompanyID": 21638,
  • "DepartmentID": 0,
  • "IsAuthorizer": false,
  • "Title": 1,
  • "FirstName": "Peter",
  • "LastName": "Andersan",
  • "Gender": "M",
  • "DOB": "2021-09-20T15:08:30.5115771+05:30",
  • "JobTitle": "job title1",
  • "ConsumerCode": "EMP124",
  • "Nationality": "440",
  • "EmailAddress": "peterandersan123@gmail.com",
  • "MobileNumber": "9876543210",
  • "MobileISOCountryCode": "826",
  • "Landlinenumber": "3216547",
  • "LandlineISOCountryCode": "826",
  • "CardDesignCode": "",
  • "CardLine4Data": "string",
  • "CardLine5Data": "string",
  • "IsUBO": true,
  • "SharePercent": 26,
  • "PersonalIdentificationNumber": "11111111120",
  • "CardLimit": {
    },
  • "IsSkipCardIssuance": true,
  • "PersonID": "string",
  • "BusinessID": "string",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumerID": 76216,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Add Location

Add new location 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

The object req information.

CompanyID
required
integer <int32>

Unique identifier of the company.

LocationName
required
string [ 0 .. 100 ] characters

Name of the company's location.

Website
required
string [ 0 .. 200 ] characters

Website of the company.

PhoneNumber
required
string [ 6 .. 50 ] characters

Phone number of the company.

PhoneNumberISOCountryCode
required
string [ 3 .. 4 ] characters

Country code of the associated with the phone 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

Success

400

Bad Request

500

Server Error

post/Business/AddLocation
Request samples
application/json
{
  • "CompanyID": 20365,
  • "LocationName": "Skipton",
  • "Website": "www.demoexample.com",
  • "PhoneNumber": "9033787834",
  • "PhoneNumberISOCountryCode": "826",
  • "Address": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "LocationID": 0,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Change Terms

ChangeTerms method is used to change the existing terms and agreement package for a 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

ChangeTermsReq

AgreementCode
required
string [ 0 .. 8 ] characters

Unique identifier of an agreement that is to be applied to an account.

PackageEffectiveDate
required
string <date-time>

The date from which the new agreement package is to be effective.
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.

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

Success

400

Bad Request

500

Server Error

post/Business/ChangeTerms
Request samples
application/json
{
  • "AgreementCode": "ABCXYZ",
  • "PackageEffectiveDate": "2021-11-19T13:27:32.0266383+05:30",
  • "CompanyID": 20365,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Balance

Returns the latest balance of the company's account.

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

GetBalanceReq

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

Success

400

Bad Request

500

Server Error

post/Business/GetBalance
Request samples
application/json
{
  • "CompanyID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ISOAccountCurrencyCode": "826",
  • "FriendlyName": "DemoExample Group Main",
  • "AccountStatus": "Live",
  • "AccountBalance": 9983922,
  • "DebitHoldBalance": 0,
  • "CreditHoldBalance": 0,
  • "EnvelopeHoldBalance": 0,
  • "AvailableBalance": 9983922,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Card Limits

Returns card spend limit of the business account.

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

The object req information.

CardID
required
integer <int32>

Unique identifier of the card.

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

Success

400

Bad Request

500

Server Error

post/Business/GetCardLimits
Request samples
application/json
{
  • "CardID": 17817,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Limit": {
    },
  • "LimitUsed": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Limits

Returns the set and utlized card spend limits of the company's account.

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

GetBalanceReq

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

Success

400

Bad Request

500

Server Error

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

Get Specific Company

Returns name, registration and VAT number, the date of establishment, address, website URL, list of directors and account number of the specified 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

The object req information.

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

Success

400

Bad Request

500

Server Error

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

Get Specific Location

Returns name of the location and address of the company, including its website and phone number.

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

The object req information.

LocationID
required
integer <int32>

Unique identifier of the company's location.

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

Success

400

Bad Request

500

Server Error

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

List Companies

Returns list of names of companies registered under the specified code. Also returns information like registration and VAT number; account number, annual turnover and profit of all the listed companies.

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

The object req information.

SchemeCode
required
string

Unique code specific to each scheme.

RegistrationNumber
string

RegistrationNumber.

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

Success

400

Bad Request

500

Server Error

post/Business/ListCompanies
Request samples
application/json
{
  • "SchemeCode": "[SchemeCode]",
  • "RegistrationNumber": "[RegistrationNumber]",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CompanyList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Consumers by Company

Returns list of personal and account information of primary and secondary consumers by Company Id.

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

ListConsumersReq

CompanyDetailID
required
integer <int32>

Unique identifier of the company.

RowIndex
integer <int32>

A number that denotes the postion of the row in the rows collection of the table.

Pagesize
integer <int32>

Pagesize The number of rows to be accomodated in a single page. If value is not provided by the user then default value is accepted. Maximum supported value is 200.

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

Success

400

Bad Request

500

Server Error

post/Business/ListConsumersByCompany
Request samples
application/json
{
  • "CompanyDetailID": 1,
  • "RowIndex": 1,
  • "Pagesize": 2,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CompanyID": 19288,
  • "CompanyName": "DemoExample Group",
  • "ConsumerResList": [
    ],
  • "TotalRows": 20,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Locations

Returns list of locations 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

The object req information.

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

Success

400

Bad Request

500

Server Error

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

List Pending Card Authorizations

Returns list of uncleared/pending card transactions.

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

ListPendingCardAuthorizationsReq

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

Success

400

Bad Request

500

Server Error

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

List Terms

Returns list of terms and conditions of the business account as per agreement.

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

The request information.

TypesOfBusiness
integer <int32>

The TypesOfBusiness

0 = None
1 = Sole Trader
2 = Partnership
3 = Limited Company
4 = Basic Business
5 = Advanced Business
6 = Reseller Business

Enum: "None" "SoleTrader" "Partnership" "Limited_Company" "Basic_Business" "Advanced_Business" "Reseller_Business"
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

Success

400

Bad Request

500

Server Error

post/Business/ListTerms
Request samples
application/json
{
  • "TypesOfBusiness": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TermsResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Terms History

Returns list of terms and conditions of the business account as per agreement.

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

The request information.

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

Success

400

Bad Request

500

Server Error

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

List Transactions

Returns list of transactions based on search criteria

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

The object req information.

CompanyID
required
integer <int32>

Unique identifier of the company.

FromDate
required
string <date-time>

The start date of transaction statement.

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.

ToDate
required
string <date-time>

The end date of transaction statement.

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.

Reference
string [ 0 .. 50 ] characters

Reference no of the transaction.

RowIndex
integer <int32>

A number that denotes the position of the row in rows collection of a table..

Pagesize
integer <int32>

The number of rows to be accomodated in a single page. If value is not provided by the client then default value is accepted. Maximum supported value is 200.

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

Success

400

Bad Request

500

Server Error

post/Business/ListTransactions
Request samples
application/json
{
  • "CompanyID": 24179,
  • "FromDate": "2021-09-19T09:38:30.2024008Z",
  • "ToDate": "2021-09-20T09:38:30.2024008Z",
  • "Reference": "",
  • "RowIndex": 1,
  • "Pagesize": 5,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TotalRows": 259,
  • "TransactionResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Transactions V2

Returns list of transactions based on search criteria

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

The object req information.

CompanyID
required
integer <int32>

Unique identifier of the company.

FromDate
required
string <date-time>

The start date of transaction statement.

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.

ToDate
required
string <date-time>

The end date of transaction statement.

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.

Reference
string [ 0 .. 50 ] characters

Reference no of the transaction.

RowIndex
integer <int32>

A number that denotes the position of the row in rows collection of a table..

Pagesize
integer <int32>

The number of rows to be accomodated in a single page. If value is not provided by the client then default value is accepted. Maximum supported value is 200.

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

Success

400

Bad Request

500

Server Error

post/Business/ListTransactionsV2
Request samples
application/json
{
  • "CompanyID": 24179,
  • "FromDate": "2021-09-19T09:38:30.2024008Z",
  • "ToDate": "2021-09-20T09:38:30.2024008Z",
  • "Reference": "",
  • "RowIndex": 1,
  • "Pagesize": 5,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TotalRows": 259,
  • "TransactionResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Registration

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

RegistrationReq

BusinessID
required
string [ 0 .. 500 ] characters

CRR BusinessID

required
Array of objects (RegistrationPersonReq)

Information about the Person(s) of the company.

AgreementCode
string [ 0 .. 200 ] characters

Unique identifier of the agreement.

MarketSector
integer <int32>

The sector of the market in which company does business.

1 = IT
2 = Telecom
3 = Pharmaceutical
4 = Construction
5 = Textiles
6 = Cement
7 = Paper
8 = Farming
9 = Mining
10 = Manufacturing
11 = Power_Supply_or_Air_Condition
12 = Water
13 = Car_Trading_or_Repair
14 = Logistics
15 = Hospitality
16 = Financial_Services
17 = RealEstate
18 = Science
19 = Admin
20 = Public_Sector
21 = Education
22 = Health_and_Social
23 = Creative_Arts
24 = Household_Activities
25 = Extraterritorial_Organisations

Enum: "None" "IT" "Telecom" "Pharmaceutical" "Construction" "Textiles" "Cement" "Paper" "Farming" "Mining" "Manufacturing" "Power_Supply_or_Air_Condition" "Water" "Car_Trading_or_Repair" "Logistics" "Hospitality" "Financial_Services" "RealEstate" "Science" "Admin" "Public_Sector" "Education" "Health_and_Social" "Creative_Arts" "Household_Activities" "Extraterritorial_Organisations"
AnnualTurnover
integer <int64>

Annual turnover of the company.

AnnualProfit
integer <int64>

Get or Set AnnualProfit

IsRegistrationTermsAgreed
required
boolean

IsRegistrationTermsAgreed Must be true
Valid values are true or false.

object (RegistrationContactReq)

RegistrationContactReq

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

Success

400

Bad Request

500

Server Error

post/Business/Registration
Request samples
application/json
{
  • "BusinessID": "string",
  • "Persons": [
    ],
  • "AgreementCode": "5EJYKHTY",
  • "MarketSector": 1,
  • "AnnualTurnover": 0,
  • "AnnualProfit": 0,
  • "IsRegistrationTermsAgreed": true,
  • "Contact": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Directors": [
    ],
  • "CompanyID": 256,
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Card Limits

Set up card spend limit for ATM, POS and Ecommerce.

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

The object req information.

CardID
required
integer <int32>

Unique identifier of the card.

ATMDailyLimit
integer <int64>

The total amount that can be withdrawn from ATM in one day.

ATMWeeklyLimit
integer <int64>

The total amount that can be withdrawn from ATM in one week.

ATMMonthlyLimit
integer <int64>

The total amount that can be withdrawn from ATM in one month.

ATMYearlyLimit
integer <int64>

The total amount that can be withdrawn from ATM in one year.

POSDailyLimit
integer <int64>

The total amount that can be spent at POS in one day.

POSWeeklyLimit
integer <int64>

The total amount that can be spent at POS in one week.

POSMonthlyLimit
integer <int64>

The total amount that can be spent at POS in one month.

POSYearlyLimit
integer <int64>

The total amount that can be spent at POS in one year..

DailyTotalLimit
integer <int64>

The total amount that can be spent in one day.

WeeklyTotalLimit
integer <int64>

The total amount that can be spent in one week.

MonthlyTotalLimit
integer <int64>

The total amount that can be spent in one month.

YearlyTotalLimit
integer <int64>

The total amount that can be spent in one year.

ECommDailyLimit
integer <int64>

The total amount that can be spent though Ecomm transactions in one day.

ECommWeeklyLimit
integer <int64>

The total amount that can be spent though Ecomm transactions in one week.

ECommMonthlyLimit
integer <int64>

The total amount that can be spent though Ecomm transactions in one month.

ECommYearlyLimit
integer <int64>

The total amount that can be spent though Ecomm transactions in one year.

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

Success

400

Bad Request

500

Server Error

post/Business/SetCardLimits
Request samples
application/json
{
  • "CardID": 1,
  • "ATMDailyLimit": 10,
  • "ATMWeeklyLimit": 10,
  • "ATMMonthlyLimit": 10,
  • "ATMYearlyLimit": 10,
  • "POSDailyLimit": 10,
  • "POSWeeklyLimit": 10,
  • "POSMonthlyLimit": 10,
  • "POSYearlyLimit": 10,
  • "DailyTotalLimit": 100,
  • "WeeklyTotalLimit": 100,
  • "MonthlyTotalLimit": 100,
  • "YearlyTotalLimit": 100,
  • "ECommDailyLimit": 5,
  • "ECommWeeklyLimit": 5,
  • "ECommMonthlyLimit": 5,
  • "ECommYearlyLimit": 5,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Limits

Set up the limits of business account for ATM, POS and Ecommerce.

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

GetBalanceReq

CompanyID
required
integer <int32>

Unique identifier of the company.

ATMDailyLimit
required
integer <int64>

The total amount that can be withdrawn from ATM in one day.

ATMWeeklyLimit
required
integer <int64>

The total amount that can be withdrawn from ATM in one week.

ATMMonthlyLimit
required
integer <int64>

The total amount that can be withdrawn from ATM in one month.

ATMYearlyLimit
required
integer <int64>

The total amount that can be withdrawn from ATM in one year.

POSDailyLimit
required
integer <int64>

The total amount that can be spent at POS in a day.

POSWeeklyLimit
required
integer <int64>

The total amount that can be spent at POS in a week.

POSMonthlyLimit
required
integer <int64>

The total amount that can be spent at POS in a month.

POSYearlyLimit
required
integer <int64>

The total amount that can be spent at POS in a year.

DailyTotalLimit
required
integer <int64>

The total amount that can be spent in a day.

WeeklyTotalLimit
required
integer <int64>

The total amount that can be spent in a week.

MonthlyTotalLimit
required
integer <int64>

The total amount that can be spent in a month.

YearlyTotalLimit
required
integer <int64>

The total amount that can be spent in a year.

ECommDailyLimit
required
integer <int64>

The total amount that can be spent though Ecomm transactions in a day.

ECommWeeklyLimit
required
integer <int64>

The total amount that can be spent though Ecomm transactions in a week.

ECommMonthlyLimit
required
integer <int64>

The total amount that can be spent though Ecomm transactions in a month.

ECommYearlyLimit
required
integer <int64>

The total amount that can be spent though Ecomm transactions in a year.

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

Success

400

Bad Request

500

Server Error

post/Business/SetLimits
Request samples
application/json
{
  • "CompanyID": 20365,
  • "ATMDailyLimit": 100,
  • "ATMWeeklyLimit": 200,
  • "ATMMonthlyLimit": 300,
  • "ATMYearlyLimit": 400,
  • "POSDailyLimit": 100,
  • "POSWeeklyLimit": 200,
  • "POSMonthlyLimit": 300,
  • "POSYearlyLimit": 400,
  • "DailyTotalLimit": 1000,
  • "WeeklyTotalLimit": 2000,
  • "MonthlyTotalLimit": 3000,
  • "YearlyTotalLimit": 4000,
  • "ECommDailyLimit": 100,
  • "ECommWeeklyLimit": 200,
  • "ECommMonthlyLimit": 300,
  • "ECommYearlyLimit": 400,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Sole Trader Registration

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

SoleTraderRegistrationReq

BusinessID
required
string

CRR BusinessID

required
object (PersonReq)

PersonReq

AgreementCode
string [ 0 .. 200 ] characters

Unique identifier of the agreement.

MarketSector
integer <int32>

The sector of the market in which company does business.

1 = IT
2 = Telecom
3 = Pharmaceutical
4 = Construction
5 = Textiles
6 = Cement
7 = Paper
8 = Farming
9 = Mining
10 = Manufacturing
11 = Power_Supply_or_Air_Condition
12 = Water
13 = Car_Trading_or_Repair
14 = Logistics
15 = Hospitality
16 = Financial_Services
17 = RealEstate
18 = Science
19 = Admin
20 = Public_Sector
21 = Education
22 = Health_and_Social
23 = Creative_Arts
24 = Household_Activities
25 = Extraterritorial_Organisations

Enum: "None" "IT" "Telecom" "Pharmaceutical" "Construction" "Textiles" "Cement" "Paper" "Farming" "Mining" "Manufacturing" "Power_Supply_or_Air_Condition" "Water" "Car_Trading_or_Repair" "Logistics" "Hospitality" "Financial_Services" "RealEstate" "Science" "Admin" "Public_Sector" "Education" "Health_and_Social" "Creative_Arts" "Household_Activities" "Extraterritorial_Organisations"
AnnualTurnover
integer <int64>

Annual turnover of the company.

AnnualProfit
integer <int64>

Get or Set AnnualProfit

IsRegistrationTermsAgreed
required
boolean

IsRegistrationTermsAgreed Must be true
Valid values are true or false.

object (RegistrationContactReq)

RegistrationContactReq

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

Success

400

Bad Request

500

Server Error

post/Business/SoleTraderRegistration
Request samples
application/json
{
  • "BusinessID": "string",
  • "Person": {
    },
  • "AgreementCode": "5EJYKHTY",
  • "MarketSector": 1,
  • "AnnualTurnover": 0,
  • "AnnualProfit": 0,
  • "IsRegistrationTermsAgreed": true,
  • "Contact": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "CompanyID": 256,
  • "Directors": [
    ],
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Company Contact Details

Update consumer's mobile number,address,registered 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

UpdateCompanyContactDetailsReq

CompanyID
required
integer <int32>

Unique identifier of the consumer.

MobileNumber
string [ 0 .. 50 ] characters

The mobile number of the company without the country code. Must be passed to update the mobile number.

MobileNumberISOCountryCode
string [ 0 .. 3 ] characters

Mobile number country code in three-digit ISO 3166-1 numeric code format. Must be passed to update Mobile number. Required when MobileNumber is passed.

EmailAddress
string [ 0 .. 100 ] characters

Primary email address of the company. MUST be passed to update the email address.

object (AddressReq)
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

Success

400

Bad Request

500

Server Error

post/Business/UpdateCompanyContactDetails
Request samples
application/json
{
  • "CompanyID": 42603,
  • "MobileNumber": "1234567890",
  • "MobileNumberISOCountryCode": "826",
  • "EmailAddress": "abc@xyz.com",
  • "Address": {
    },
  • "RegisteredAddress": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Company Details

Updates information 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

The object req information.

CompanyID
required
integer <int32>

Unique identifier of the company.

CompanyName
string [ 0 .. 200 ] characters

Name of the company.

VATNumber
string [ 0 .. 100 ] characters

Value Added Tax (VAT) number of the company.

RegistrationNumber
string [ 0 .. 50 ] characters

Registration number of the company.

EstablishedOn
string <date-time>

Date of establishment of the company.
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.

MarketSector
integer <int32>

The sector of the market in which company does business.

1 = IT
2 = Telecom
3 = Pharmaceutical
4 = Construction
5 = Textiles
6 = Cement
7 = Paper
8 = Farming
9 = Mining
10 = Manufacturing
11 = Power_Supply_or_Air_Condition
12 = Water
13 = Car_Trading_or_Repair
14 = Logistics
15 = Hospitality
16 = Financial_Services
17 = RealEstate
18 = Science
19 = Admin
20 = Public_Sector
21 = Education
22 = Health_and_Social
23 = Creative_Arts
24 = Household_Activities
25 = Extraterritorial_Organisations

Enum: "None" "IT" "Telecom" "Pharmaceutical" "Construction" "Textiles" "Cement" "Paper" "Farming" "Mining" "Manufacturing" "Power_Supply_or_Air_Condition" "Water" "Car_Trading_or_Repair" "Logistics" "Hospitality" "Financial_Services" "RealEstate" "Science" "Admin" "Public_Sector" "Education" "Health_and_Social" "Creative_Arts" "Household_Activities" "Extraterritorial_Organisations"
AnnualTurnover
integer <int64>

Annual turnover of the company.

AnnualProfit
integer <int64>

Annual profit 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

Success

400

Bad Request

500

Server Error

post/Business/UpdateCompanyDetails
Request samples
application/json
{
  • "CompanyID": 20366,
  • "CompanyName": "Credecard Pvt. Ltd.",
  • "VATNumber": "CON143",
  • "RegistrationNumber": "COM145",
  • "EstablishedOn": "2021-09-20T15:08:29.6658189+05:30",
  • "MarketSector": 1,
  • "AnnualTurnover": 0,
  • "AnnualProfit": 0,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Consumer Contact Details

Update consumer's mobile number 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

UpdateConsumerContactDetailsReq

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

MobileNumber
string [ 0 .. 50 ] characters

The mobile number of the consumer without the country code. Must be passed to update the mobile number.

MobileNumberISOCountryCode
string [ 0 .. 3 ] characters

Mobile number country code in three-digit ISO 3166-1 numeric code format. Must be passed to update Mobile number. Required when MobileNumber is passed.

EmailAddress
string [ 0 .. 100 ] characters

Primary email address of the consumer. MUST be passed to update the email address.

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

Success

400

Bad Request

500

Server Error

post/Business/UpdateConsumerContactDetails
Request samples
application/json
{
  • "ConsumerID": 42603,
  • "MobileNumber": "1234567890",
  • "MobileNumberISOCountryCode": "826",
  • "EmailAddress": "abc@xyz.com",
  • "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 Consumer Detail

Updates consumer’s personal information like name, gender, date of birth, including details of passport, driving license and national identity card.

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

UpdateConsumerDetailReq

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

Title
integer <int32>

The title of the consumer. Title must be from one of the values as - "Mr, Mrs, Miss, Ms, Dr, Sir, Prof, Other"

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 consumer.

LastName
string [ 0 .. 50 ] characters

The last name of consumer.

DepartmentID
integer <int32>

Unique identifier of the department in the company. If value = 0 is passed, then it will retain the existing value only and 0 will not be considered for updation.

ConsumerCode
string

Unique code assigned to a comsumer/employee in the company.

JobTitle
string

The title that identifies the type of job of the consumer/employee in the company.

Gender
string [ 0 .. 1 ] characters

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

DOB
string <date-time>

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

Language
string [ 0 .. 2 ] characters

The langauge used in the scheme setting and agreement. The language look up value MUST be passed, otherwise the default langauge will be considered.

Relationship
integer <int32>

The look up value that identifies the

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

Enum: "None" "Self" "Family" "Friend" "Colleague" "Managed"
Nationality
string [ 0 .. 3 ] characters

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

PassportNumber
string [ 0 .. 44 ] characters

The passport number of the consumer. 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>

Expiry date of the valid 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

The driving license number of the consumer. It must be alphanumeric and have 16-character length.
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 [ 0 .. 60 ] characters

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: for UK: ^[a-zA-Z0-9/ ,.+=\\<]{5,60}$, for all other countries: ^[a-zA-Z0-9/ ,.+=\\-]{5,60}$.

NationalIDCardLine2
string

Line 2 detail from consumer's national ID card.

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.

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

Success

400

Bad Request

500

Server Error

post/Business/UpdateConsumerDetail
Request samples
application/json
{
  • "ConsumerID": 42603,
  • "Title": 1,
  • "FirstName": "XYZ",
  • "LastName": "ABC",
  • "DepartmentID": 876,
  • "ConsumerCode": "CUST001",
  • "JobTitle": "JOB1",
  • "Gender": "F",
  • "DOB": "2001-09-20T15:08:30.562443+05:30",
  • "Language": "01",
  • "Relationship": 1,
  • "Nationality": "440",
  • "PassportNumber": "",
  • "PassportExpiryDate": "2021-09-20T15:08:30.5634406+05:30",
  • "DrivingLicenceNumber": "string",
  • "NationalIDCardLine1": "",
  • "NationalIDCardLine2": "",
  • "SharePercent": 26,
  • "PersonalIdentificationNumber": "11992244661",
  • "IsUBO": true,
  • "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.