Consumer Security API (V2)

Download OpenAPI specification:Download

ConsumerSecurity

The APIs in the consumer security controller enable you to securely log in and log out of API account. Login API authenticates the token and authorizes login. The log out API expires the token to log you out of the API account. This controller allows Solaris consumers to do login and manage their own account and other functionality. This Controller is mainly aim for B2C, Where consumer credentials are managed in the Solaris platform.

Get Login Tokens

Sign in to the API account for 2FA.

Request
Request Body schema: multipart/form-data
GRANT_TYPE
required
string = 8 characters

The grant_type header parameter is required by OAuth2 RFC for the /login endpoint, which exchanges a grant for real tokens. This field must contain the value "password"

SCAReferenceNumber
required
string = 36 characters

Solaris will provide ReferenceNumber against generated 8-Digit OTP to Consumer which need to present in Authorize API along with respective 8-Digit OTP.

Responses
200

Success

400

Bad Request

500

Server Error

post/ConsumerSecurity/GetLoginTokens
Response samples
application/json
{
  • "Contis_ConsumerID": "21",
  • "Contis_Token": "[Token]",
  • "Contis_PasswordExpiryDate": "2020-07-07T10:42:40.0782314+05:30",
  • "Contis_UserTypeID": "1",
  • "access_token": "[access_token]",
  • "token_type": "bearer",
  • "expires_in": 43199,
  • "Contis_SecurityKey": "[SecurityKey]",
  • ".expires": "2021-06-07T09:13:44.6402008+05:30",
  • ".issued": "2021-06-07T09:10:44.6402008+05:30"
}

Get SCA Status

GetSCAStatus method is used to get the status of ReferenceNumber for SCA.

Request
Request Body schema: application/json

GetSCAProcessStatusReq

SCAReferenceNumber
required
string = 36 characters

Unique reference number generated against consumer OTP provided by Solaris.

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/ConsumerSecurity/GetSCAStatus
Request samples
application/json
{
  • "SCAReferenceNumber": "B3696C05-04C5-42C7-B34A-F71CEF362D3C",
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "SCAStatus": "Pending",
  • "SCAStatuscode": 1,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Security Questions

Returns list of security questions.

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

ListSecurityQuestionsReq

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

Login

Sign in to the API account.
Please click here for more details regarding response examples.

Request
Request Body schema: multipart/form-data
GRANT_TYPE
required
string = 8 characters

The grant_type header parameter is required by OAuth2 RFC for the /login endpoint, which exchanges a grant for real tokens. This field must contain the value "password"

UserName
required
string [ 8 .. 100 ] characters

Username required for login. It must be 8 to 20 characters and should not contain special characters for those who don't allowed Email as Username.

Password
required
string [ 8 .. 20 ] characters

The password required for login. It must be 8 to 20 characters and should contain at least one upper case, one lower case letter and a special character. The allowed characters are a-z, A-Z, 0-9 and special characters ! @ $ # % ^ & * + = ( ).

SchemeCode
required
string [ 0 .. 6 ] characters

The Schemecode required for login, Unique identifier of the scheme.

LoginTypeID
integer <int32>

Unique identifier of the login type.
Note: It is required in case of SCA is ON at login event.
Values can be, 2 = Account login, 15 = Mobile Login, 16 = MPin Mobile Login, 17 = Fingerprint Mobile Login, 19 = FaceID Mobile Login.

Responses
200

Success

400

Bad Request

500

Server Error

post/ConsumerSecurity/login
Response samples
application/json
{
  • "Contis_ConsumerID": "21",
  • "Contis_Token": "[Token]",
  • "Contis_PasswordExpiryDate": "2020-07-07T10:42:40.0782314+05:30",
  • "Contis_UserTypeID": "1",
  • "access_token": "[access_token]",
  • "token_type": "bearer",
  • "expires_in": 43199,
  • "Contis_SecurityKey": "[SecurityKey]",
  • ".expires": "2021-06-07T09:13:44.6402008+05:30",
  • ".issued": "2021-06-07T09:10:44.6402008+05:30"
}

Login 1FA

The Login 1FA method is used to perform the 1st factor authentication (1FA) of a login. This method accepts login request of 1st factor authentication (1FA, i.e. username and password). It will return appropriate API response with required authorization details including reference number and OTP (One time Passcode) which will be sent to consumer's registered mobile number and email address. The reference number is then required to pass in 2nd factor authentication (2FA) along with SCA Identification (For e.g. OTP (One Time Passcode) sent to Consumer) to get secure access to the API.

Request
Request Body schema: multipart/form-data
UserName
string [ 0 .. 100 ] characters

Username required for LoginTypeID is 15 (Mobile Login) and 2 (Account login). It must be 8 to 20 characters and should not contain special characters for those who don't have allowed Email as Username facility.

Password
string [ 0 .. 20 ] characters

The password required for login if login performing via username and password. It must be 8 to 20 characters and should contain at least one upper case, one lower case letter and a special character. The allowed characters are a-z, A-Z, 0-9 and special characters ! @ $ # % ^ & * + = ( ).

SchemeCode
string [ 0 .. 6 ] characters

Unique identifier of the scheme provided by Solaris.

MPin
string [ 0 .. 50 ] characters

The Mobile PIN (mPIN) is required if login performing via mobile application and LoginTypeID is 16 (MPin Mobile Login), 17 (Fingerprint Mobile Login) or 19 (FaceID Mobile Login)

LoginTypeID
required
integer <int32>

The login type identifier is required to identity type of login. Values can be, 2 = Account login, 15 = Mobile Login, 16 = MPin Mobile Login, 17 = Fingerprint Mobile Login, 19 = FaceID Mobile Login.

MobileInfo.DeviceID
required
string [ 0 .. 50 ] characters

System generated unique Identification number of the mobile device linked to the account.

MobileInfo.ApplicationID
required
string [ 0 .. 50 ] characters

Application identifier.

MobileInfo.MobileGroupId
required
integer <int32>

The mobile group identifier.

MobileInfo.AppName
required
string [ 0 .. 20 ] characters

Name of the application.

MobileInfo.AppVersion
required
string [ 0 .. 20 ] characters

Application version.

MobileInfo.MobileOSVersion
required
string [ 0 .. 25 ] characters

Mobile os version.

MobileInfo.DeviceInformation
required
string [ 0 .. 250 ] characters

The device information.

MobileInfo.MobileAppVersionID
required
integer <int32>

The mobile application version identifier.

MobileInfo.DeviceName
required
string [ 0 .. 50 ] characters

Name of the device.

MobileInfo.DeviceTypeID
required
integer <int32> [ 1 .. 32767 ]

Device type identifier.

1 = Android
2 = iOS

Enum: "None" "Android" "iOS"
Token
string [ 0 .. 8 ] characters

Unique identifier of an application requesting API access.

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/ConsumerSecurity/Login_1FA
Response samples
application/json
{
  • "ExpiryDateTime": "2021-07-27T11:02:04.2552855+05:30",
  • "AuthCode": "[AuthCode]",
  • "SCARes": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Logout

Expire the token and log out from the 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.

LogoutReason
integer <int32>

Reasons for Logout

0 = None
1 = Manually logout
2 = Session timeout
3 = Logged in to another device
4 = Lost connection
5 = Force close the app
6 = Login disabled

Enum: "None" "ManuallyLogout" "SessionTimeout" "LoggedIntoAnotherDevice" "LostConnection" "ForceCloseTheApp" "LoginDisabled"
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/ConsumerSecurity/logout
Request samples
application/json
{
  • "LogoutReason": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Security Answer

Updates the security answer. The security answer is used for validation when the user or customer calls Solaris support service.

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 securty answer request information.

ConsumerID
required
integer <int32>

Unique identifier of the consumer.

QuestionID
required
string

The ID of the security question for which security answer is to be updated.

Answer
required
string [ 4 .. 100 ] characters

The answer for the given question.The answer must not contain any special characters.

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/ConsumerSecurity/UpdateSecurityAnswer
Request samples
application/json
{
  • "ConsumerID": 21,
  • "QuestionID": "05",
  • "Answer": "Mango",
  • "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.