Consumer API (V2)

Download OpenAPI specification:Download

Consumer

Provides methods for Consumer creation and management, and to facilitate Solaris EMI KYC workflows.

Add Additional Consumer

Creates a new consumer and assigns them to the primary account of the supplied ParentConsumerID. Additional consumers share the same agreement, program, currency etc. as the primary account to which it is being added.

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.

ParentConsumerID
required
integer <int32>

Unique identifier of the primary consumer. The field is required while adding additional or junior consumer and to establish its relationship with Parent Consumer account.

required
object (AdditionalConsumerReq)

Consumer detail request object is used for adding personal details of a consumer.

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/Consumer/AddAdditionalConsumer
Request samples
application/json
{
  • "ParentConsumerID": 55320,
  • "ConsumerDetail": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumerID": 76049,
  • "ShipmentMethodCode": "BULK044",
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Add Additional Consumer With Account

Creates a new consumer and assigns them to a new sub account under the existing primary account of the supplied ParentConsumerID. The new consumer shares the same program, agreement, and currency as the primary 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 request information.

ParentConsumerID
integer <int32>

Unique identifier of the primary consumer. The field is required while adding additional or junior consumer and to establish its relationship with Parent Consumer account.

required
object (AdditionalConsumerReq)

Consumer detail request object is used for adding personal details of a consumer.

AgreementCode
string [ 0 .. 8 ] characters

Unique identifier of an agreement. Agreement code is same for primary and secondary account(s).

AccountFriendlyName
string [ 0 .. 50 ] characters

Friendly name of an account to identify an account easily from multiple accounts.

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/Consumer/AddAdditionalConsumerWithAccount
Request samples
application/json
{
  • "ParentConsumerID": 55320,
  • "ConsumerDetail": {
    },
  • "AgreementCode": "AGRMNTWS",
  • "AccountFriendlyName": "AccName",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumerID": 76049,
  • "ShipmentMethodCode": "BULK044",
  • "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
}

Add Consumers

Creates a new consumer (or consumers) and associated account, to which all consumers in the request will be assigned.

If more than one consumer is included in the ConsumerReqList array, at least one must be specified as the primary consumer using the IsPrimaryConsumer parameter. If only one consumer is provided, this will be considered the primary consumer by default.

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.

Array of objects (ConsumerReq)

List of consumers to be created, including primary and secondary.

PromotionalCode
string [ 0 .. 10 ] characters

Series of letters and numbers that enable a consumer to get discount.

AgreementCode
string [ 0 .. 8 ] characters

Unique identifier of an agreement. Agreement code is same for primary and secondary account(s).

Language
integer <int32>

The language used in the scheme settings. If language look up value is not provided then default language is considered.

1 = English
2 = Russian
3 = Latvian
4 = EnglishLatvian
5 = Polish
6 = Lithuanian
8 = Chinese
9 = Albanian
10 = French
11 = Romanian
12 = German
13 = Italian
14 = Spanish

Enum: "None" "English" "Russian" "Latvian" "EnglishLatvian" "Polish" "Lithuanian" "Chinese" "Albanian" "French" "Romanian" "German" "Italian" "Spanish"
AccountFriendlyName
string [ 0 .. 50 ] characters

Friendly name of an account to identify an account easily from multiple accounts.

PayeeRef
string [ 0 .. 50 ] characters

Payee reference of an account to identify an account for future transfer

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/Consumer/AddConsumers
Request samples
application/json
{
  • "ConsumerReqList": [
    ],
  • "PromotionalCode": "PROMO",
  • "AgreementCode": "AGRMNTWS",
  • "Language": 1,
  • "AccountFriendlyName": "AccName",
  • "PayeeRef": "",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Status": 1,
  • "ConsumerPersonalResList": [
    ],
  • "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
}

Document Verification Process

Used to submit Document Verification image captures for the Document Verification and Facial Comparison (DVFC) KYC stage. This method must be used in conjunction with the Consumer/FacialComparisonProcess method to provide all required image captures.

Usage of this method is only applicable for partners using the KYC solution provided by Solaris, and can be called only once for a given KYCClientReferenceID.

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

DocumentVerificationProcessReq

KYCClientReferenceID
string <uuid>

ClientReferenceID. Auto generated field, Received at time Consumer/AddConsumer API called when W2Gbolal as Service Provider configured against program.

DocumentTypeID
integer <int32>

DocumentTypeID.

1 = Passport
2 = Driving Licence
3 = Identity Card

Enum: "NONE" "PASSPORT" "DRIVERS_LICENSE" "ID_CARD"
DocumentFrontImage
required
string <byte>

DocumentFrontSide.

DocumentBackImage
string <byte>

DocumentBackImage.

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/Consumer/DocumentVerificationProcess
Request samples
application/json
{
  • "KYCClientReferenceID": "e263edc3-61af-4f38-aabd-4b4998edc9fd",
  • "DocumentTypeID": 1,
  • "DocumentFrontImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
  • "DocumentBackImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DocumentVerificationStatus": 2,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

DVFC Process

Used to submit all required image captures for the Document Verification and Facial Comparison (DVFC) KYC stage.

Usage of this method is only applicable for partners using the KYC solution provided by Solaris, and can be called only once for a given KYCClientReferenceID.

As the combined size of the binary image data required for this call may be relatively large, to reduce API request payload size it is advised to avoid calling this method and instead make separate calls to the Consumer/DocumentVerificationProcess and Consumer/DocumentVerificationProcess methods respectively.

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

DVFCProcessReq

KYCClientReferenceID
string <uuid>

ClientReferenceID. Auto generated field, Received at time Consumer/AddConsumer API called when W2Gbolal as Service Provider configured against program.

DocumentTypeID
integer <int32>

DocumentTypeID.

1 = Passport
2 = Driving Licence
3 = Identity Card

Enum: "NONE" "PASSPORT" "DRIVERS_LICENSE" "ID_CARD"
DocumentFrontImage
required
string <byte>

DocumentFrontSide.

DocumentBackImage
string <byte>

DocumentBackImage.

SelfieImage
required
string <byte>

DocumentBackImage.

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/Consumer/DVFCProcess
Request samples
application/json
{
  • "KYCClientReferenceID": "6e20b947-b8c3-47f7-8c5a-922d682f3dd3",
  • "DocumentTypeID": 1,
  • "DocumentFrontImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
  • "DocumentBackImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
  • "SelfieImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DVFCKYCStatus": 2,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Facial Comparison Process

Used to submit Facial Comparison image captures for the Document Verification and Facial Comparison (DVFC) KYC stage. This method must be used in conjunction with the Consumer/DocumentVerificationProcess method to provide all required image captures.

Usage of this method is only applicable for partners using the KYC solution provided by Solaris, and can be called only once for a given KYCClientReferenceID.

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

FacialComparisonProcessReq

KYCClientReferenceID
string <uuid>

ClientReferenceID. Auto generated field, Received at time Consumer/AddConsumer API called when W2Gbolal as Service Provider configured against program.

SelfieImage
required
string <byte>

DocumentBackImage.

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/Consumer/FacialComparisonProcess
Request samples
application/json
{
  • "KYCClientReferenceID": "007e6c06-4dc2-487d-8c4b-fa4a58276b8e",
  • "SelfieImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "FacialComparisonStatus": 2,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Address Lookup

Returns a list of addresses for the supplied Post Code.

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.

PostCode
required
string [ 0 .. 50 ] characters

Series of numbers or letters, or both, that uniquely identify the location or area.

CountryA3Code
string [ 0 .. 3 ] characters

Three-digit, CountryA3Code. This filed is require to get address for Non UK Country.

SchemeCode
required
string [ 0 .. 6 ] characters

Unique code specific to each scheme.

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/Consumer/GetAddressLookUP
Request samples
application/json
{
  • "PostCode": "string",
  • "CountryA3Code": "str",
  • "SchemeCode": "string",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AddressResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Mobile Verification Code

Sends a verification code to the mobile number of the specified consumer, for purposes of verifying their mobile device. Once sent, this code can be verified using the Consumer/VerifyMobile method.

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

ProfileGetMobileVerificationCodeRequestInfo

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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/Consumer/GetMobileVerificationCode
Request samples
application/json
{
  • "ConsumerID": 42603,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Consumer

Retrieves the specified consumer by their ConsumerID.

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

GetSpecificConsumerReq

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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/Consumer/GetSpecificConsumer
Request samples
application/json
{
  • "ConsumerID": 21,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumerID": 21,
  • "Status": 1,
  • "ConsumerRes": {
    },
  • "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
}

List Consumers

Retrieves all primary and secondary consumers for the given 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

ListConsumersReq

AccountIdentifier
integer <int32>

Unique identifier of an Account.
Note: Either Account Identifier or combination of Account Number and SortCode or combination of IBAN and BIC must be provided for API request.
For international account (outside UK) provide the combination of IBAN and BIC only.
For account within UK, provide either of the three combinations.

AccountNumber
string [ 0 .. 8 ] characters

Eight-digit account number.

SortCode
string [ 0 .. 6 ] characters

Sort code identifies both the bank and the branch where the conusmer account is held.

IBAN
string [ 0 .. 34 ] characters

International Bank Account Number (IBAN) is a unique code that identifies banks globally. The bank assigns an IBAN to each of its accounts. IBAN is used to make across the country payments process easier and faster.

BIC
string [ 0 .. 11 ] characters

Bank Identifier Code (BIC) identifies the beneficiary's bank quickly and easily. BIC contains the name, country, location and branch of the bank.

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/Consumer/ListConsumers
Request samples
application/json
{
  • "AccountIdentifier": 949838,
  • "AccountNumber": "00000570",
  • "SortCode": "608370",
  • "IBAN": "GB35CNFV60837000000570",
  • "BIC": "CNFVGB21XXX",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "ConsumerID": 73896,
  • "Status": 1,
  • "ConsumerResList": [
    ],
  • "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
}

List Terms

Retrieves the Terms and Conditions for the given 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 request information.

UserAccountType
integer <int32>

Set Account Type
Note: For getting available standard agreement (2-PersonalTopup, 4-MerchantBusiness, 6-PayOnOrder, 7-Junior, 8-NominalAccount) no need to pass this parameter

1 = Virtual
2 = Personal Topup
3 = Business
4 = Merchant Business
6 = Pay On Order
7 = Junior
8 = Nominal Account
9 = Direct Debit

Enum: "None" "Virtual" "PersonalTopup" "Business" "MerchantBusiness" "PayOnOrder" "Junior" "NominalAccount" "DirectDebit"
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/Consumer/ListTerms
Request samples
application/json
{
  • "UserAccountType": 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
}

Set Consumer as Lockout

Sets the consumer's status to Locked Out. This method is used to initiate the closure of a consumer's account. Please note it is not possible to revert a consumers's status via the API once this method has been called.

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

SetConsumerAsLockoutReq

PrimaryConsumerID
required
integer <int32>

Unique identifier of the primary consumer.

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/Consumer/SetConsumerAsLockout
Request samples
application/json
{
  • "PrimaryConsumerID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Consumer as Normal

Sets the given consumer's status to Normal (Active), enabling all permitted functionality.

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

SetConsumerAsNormalReq

PrimaryConsumerID
required
integer <int32>

Unique identifier of the primary consumer.

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/Consumer/SetConsumerAsNormal
Request samples
application/json
{
  • "PrimaryConsumerID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Consumer as Suspended

Sets the given consumer's status to Suspended, preventing any card or account related actions being performed by the consumer.

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

SetConsumerAsSuspendedReq

PrimaryConsumerID
required
integer <int32>

Unique identifier of the primary consumer.

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/Consumer/SetConsumerAsSuspended
Request samples
application/json
{
  • "PrimaryConsumerID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Unblock Consumer Login

Unblocks the previously blocked login of the specified consumer. Blocks are typically applied as a result of Password or OTP etc. validation attempts exceeding the number of attempts permitted.

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

UnblockConsumerLoginReq

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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/Consumer/UnblockConsumerLogin
Request samples
application/json
{
  • "ConsumerID": 21,
  • "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

Updates the specified consumer's contact information, such as their mobile number, email and address.

Please note that by default it is not possible to amend the consumer's address via this method if the given address has been updated within the previous 30 days. In such cases a request must be made to Solaris directly in order to action this change.

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

MobileNumber
string [ 0 .. 15 ] characters

The mobile number of the consumer should be passed if consumer wishes to update it.

MobileNumberISOCountryCode
string [ 0 .. 3 ] characters

Three-digit ISO country code of a consumer mobile should be passed if consumer wishes to update Mobile Number.

EmailAddress
string [ 0 .. 100 ] characters

Email address of the consumer should be passed if consumer wishes to update the email address.
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})$

object (AddressReq)
ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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/Consumer/UpdateConsumerContactDetails
Request samples
application/json
{
  • "MobileNumber": "1234567890",
  • "MobileNumberISOCountryCode": "826",
  • "EmailAddress": "abc@xyz.com",
  • "AddressReq": {
    },
  • "ConsumerID": 42603,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Consumer Detail

Updates the specified consumer's personal information such as Title, Name, Date of Birth etc.

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

CardDisplayName
string [ 0 .. 21 ] characters

Get or Set card display name which is display on card.

Title
integer <int32>

The title is preceding the name of consumer.

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

LastName
string [ 0 .. 50 ] characters

The last name of the consumer.

Gender
string [ 0 .. 1 ] characters

The gender of the consumer. Options ‘M’ for Male, ‘F’ for Female and ‘U’ for Unknown.

DOB
string <date-time>

Date of birth of the consumer. Required minimum age is configurable at scheme settings and validated against provided DOB of a consumer.
Format of date is 'yyyy-MM-dd', e.g. 24-May-1960 as 1960-05-24.

Language
string [ 0 .. 2 ] characters

The consumer's preferred language is set in the scheme settings and agreement. All communication with the consumer will be done in preferred set language. The language should be set by consumer, else default langauge for the scheme will be set.

Relationship
integer <int32>

The look up value that identifies

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

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

Nationality of the consumer. Allowed characters for the field are alphabets, hyphen (‐) and space.

PassportNumber
string [ 0 .. 44 ] characters

Valid passport number of a consumer.
Passport Logic :

44 string value require length of the passport.
Below is the logic of the 44 digits

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 Expiry date of the valid passport. If consumer PassportNumber is provided then valid PassportExpiryDate should be passed along with PassportNumber.
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 .. 25 ] characters

Valid driving licence number of a consumer. It should be an alphanumeric value.
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

DrivingLicenceExpiryDate
string <date-time>

The Expiry date of the valid DrivingLicense. If consumer DrivingLicense is provided then valid DrivingLicenceExpiryDate should be passed along with DrivingLicense.
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.

NationalIDCardLine1
string [ 0 .. 60 ] characters

The information on the Line 1 of the consumer's national identity card.

NationalIDCardLine2
string

The information on the Line 2 of the consumer's national identity card.

NationalIDCardExpiryDate
string <date-time>

The Expiry date of the valid NationalIDCard. If consumer NationalIDCard details is provided then valid NationalIDCardExpiryDate should be passed along with NationalIDCard.
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.

CardDesignCode
string [ 0 .. 8 ] characters

DesignCode for cards provided by Solaris.

ShipmentMethodCode
string [ 0 .. 7 ] characters

ShipmentMethodCode is used for amend existing card shipment method. To amend existing card shipment method CardDesignCode is required.

PurposeofAccount
integer <int32>

The intended purpose of the account.

1 = Occasional day to day spending / Savings.
2 = Salary / Pension / Benefits.
3 = Budgeting.
4 = Expenses linked to employment.
5 = Current Account / Every day spend.
6 = Online shopping.
7 = Trading stocks / shares / goods.
8 = Overseas transactions / Travel.
9 = Day to day spending linked to Crypto.
10 = Gambling.
11 = Investment funding.
12 = Investment funding linked to Crypto.

Occupation
integer <int32>

The user's occupation.

1 = Employed
2 = Self Employed
3 = Student
4 = Unemployed
5 = Military
6 = Apprentice
7 = Housework
8 = Retired

ExpectedYearlySpend
integer <int32>

The total amount the user expects to be spent from their account in a given year.

1 = Up to 5k
2 = 5,001 - 10,000
3 = 10,001 - 15,000
4 = 15,001 - 25,000
5 = 25,001 - 35,000
6 = 35,001 - 49,999
7 = 50k or over.

TransactionVolume
integer <int32>

The number of monthly transactions the user expects to make from the account.

1 = 0 - 50
2 = 51 - 75
3 = 75+.

OccupationDescription
string [ 0 .. 150 ] characters

The description of the user's occupation.

CountryofBirth
string [ 0 .. 3 ] characters

The user's country of birth, provided in ISO 3166-1 numeric code format.

PersonalIdentificationNumber
string [ 0 .. 11 ] characters

Lithuania Residents Person Code (only applicable for Lithuanian users).

Citizenship
string [ 0 .. 3 ] characters

The citizenship of the user provided in ISO 3166-1 numeric code format.

OtherDocumentName
string [ 0 .. 100 ] characters

The name of the other document provided for purposes of consumer identity verification. Can contain alphanumeric characters and spaces.

OtherDocumentDetails
string [ 0 .. 67 ] characters

The reference/reference number of the document referenced in OtherDocumentName, if provided. Must contain alphanumeric characters only.

OtherDocumentExpiryDate
string <date-time>

The expiry date of the document referenced in OtherDocumentName, if provided.
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.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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/Consumer/UpdateConsumerDetail
Request samples
application/json
{
  • "CardDisplayName": "",
  • "Title": 1,
  • "FirstName": "XYZ",
  • "LastName": "ABC",
  • "Gender": "F",
  • "DOB": "2001-12-21T13:58:03.9393328+05:30",
  • "Language": "1",
  • "Relationship": 1,
  • "Nationality": "British",
  • "PassportNumber": "string",
  • "PassportExpiryDate": "2021-12-21T13:58:03.9393328+05:30",
  • "DrivingLicenceNumber": "string",
  • "DrivingLicenceExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
  • "NationalIDCardLine1": "",
  • "NationalIDCardLine2": "",
  • "NationalIDCardExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
  • "CardDesignCode": "BVCPD",
  • "ShipmentMethodCode": "BULK044",
  • "PurposeofAccount": 0,
  • "Occupation": 0,
  • "ExpectedYearlySpend": 0,
  • "TransactionVolume": 0,
  • "OccupationDescription": "",
  • "CountryofBirth": "826(UK)",
  • "PersonalIdentificationNumber": "11223456789",
  • "Citizenship": "826(UK)",
  • "OtherDocumentName": "Firearms Licence ",
  • "OtherDocumentDetails": "12345dfsmsms",
  • "OtherDocumentExpiryDate": "2024-12-21T13:58:03.0734254+05:30",
  • "ConsumerID": 42603,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Verify Mobile

Requests verification of the code sent previously to the specified consumer's mobile number. Please note this method must only be called after the initial call to GetMobileVerificationCode used to send the code.

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

VerifyMobileReq

VerificationCode
required
string [ 0 .. 4 ] characters

Verification code for the consumer's main mobile number.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

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/Consumer/VerifyMobile
Request samples
application/json
{
  • "VerificationCode": "M248",
  • "ConsumerID": 42603,
  • "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.