Download OpenAPI specification:Download
Provides methods for Consumer creation and management, and to facilitate Solaris EMI KYC workflows.
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.
The request information.
OK
Bad Request
Internal Server Error
{- "ParentConsumerID": 55320,
- "ConsumerDetail": {
- "EncryptedPIN": "BjImrEf/1Opj+AtX0B86kw==",
- "CardDisplayName": "",
- "Title": 1,
- "FirstName": "Test",
- "LastName": "UserLast",
- "Gender": "M",
- "DOB": "2021-12-21T13:58:03.0734254+05:30",
- "Relationship": 1,
- "PassportNumber": "",
- "PassportExpiryDate": "2021-12-21T13:58:03.0734254+05:30",
- "DrivingLicenceNumber": "string",
- "DrivingLicenceExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
- "Nationality": "440",
- "EmailAddress": "test@email.com",
- "MobileNumber": "123456784",
- "MobileNumberISOCountryCode": "826",
- "PresentAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "PreviousAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "LivedAtPresentAddressInMonth": 0,
- "NationalIDCardLine1": "",
- "NationalIDCardLine2": "",
- "NationalIDCardExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
- "SocialSecurityNumber": "1236",
- "CardDesignCode": "string",
- "CardLine4Data": "string",
- "CardLine5Data": "string",
- "ClientSSOReferenceNumber": "",
- "IsLoginRequired": false,
- "UserName": "",
- "Password": "",
- "IsSkipCardIssuance": false,
- "ShipmentMethodCode": "",
- "OtherDocumentName": "Firearms Licence",
- "OtherDocumentDetails": "12345dfsmsms",
- "OtherDocumentExpiryDate": "2024-12-21T13:58:03.0734254+05:30"
}, - "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "ConsumerID": 76049,
- "ShipmentMethodCode": "BULK044",
- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
The request information.
OK
Bad Request
Internal Server Error
{- "ParentConsumerID": 55320,
- "ConsumerDetail": {
- "EncryptedPIN": "BjImrEf/1Opj+AtX0B86kw==",
- "CardDisplayName": "",
- "Title": 1,
- "FirstName": "Test",
- "LastName": "UserLast",
- "Gender": "M",
- "DOB": "2021-12-21T13:58:03.0734254+05:30",
- "Relationship": 1,
- "PassportNumber": "",
- "PassportExpiryDate": "2021-12-21T13:58:03.0734254+05:30",
- "DrivingLicenceNumber": "string",
- "DrivingLicenceExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
- "Nationality": "440",
- "EmailAddress": "test@email.com",
- "MobileNumber": "123456784",
- "MobileNumberISOCountryCode": "826",
- "PresentAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "PreviousAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "LivedAtPresentAddressInMonth": 0,
- "NationalIDCardLine1": "",
- "NationalIDCardLine2": "",
- "NationalIDCardExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
- "SocialSecurityNumber": "1236",
- "CardDesignCode": "string",
- "CardLine4Data": "string",
- "CardLine5Data": "string",
- "ClientSSOReferenceNumber": "",
- "IsLoginRequired": false,
- "UserName": "",
- "Password": "",
- "IsSkipCardIssuance": false,
- "ShipmentMethodCode": "",
- "OtherDocumentName": "Firearms Licence",
- "OtherDocumentDetails": "12345dfsmsms",
- "OtherDocumentExpiryDate": "2024-12-21T13:58:03.0734254+05:30"
}, - "AgreementCode": "AGRMNTWS",
- "AccountFriendlyName": "AccName",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "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
}
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.
The request information.
OK
Bad Request
Internal Server Error
{- "ConsumerReqList": [
- {
- "CardDisplayName": "",
- "EncryptedPIN": "JuEdQC30rJBWAC8Iz4LWfQ==",
- "Title": 1,
- "FirstName": "Test",
- "LastName": "UserLast",
- "Gender": "M",
- "DOB": "2021-08-06T10:19:49.5523123+05:30",
- "Relationship": 1,
- "PassportNumber": "",
- "PassportExpiryDate": "2021-08-06T10:19:49",
- "DrivingLicenceNumber": "",
- "DrivingLicenceExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
- "Nationality": "440",
- "EmailAddress": "test@email.com",
- "MobileNumber": "123456784",
- "MobileNumberISOCountryCode": "826",
- "PresentAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "PreviousAddress": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "LivedAtPresentAddressInMonth": 0,
- "NationalIDCardLine1": "",
- "NationalIDCardLine2": "",
- "NationalIDCardExpiryDate": "2023-12-21T13:58:03.0734254+05:30",
- "SocialSecurityNumber": "",
- "IsPrimaryConsumer": false,
- "CardDesignCode": "",
- "CardLine4Data": "",
- "CardLine5Data": "",
- "ClientSSOReferenceNumber": "",
- "IsLoginRequired": false,
- "UserName": "",
- "Password": "",
- "IsSkipKYC": false,
- "IsSkipSanctionCheck": false,
- "IsSkipCardIssuance": false,
- "ShipmentMethodCode": "",
- "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"
}
], - "PromotionalCode": "PROMO",
- "AgreementCode": "AGRMNTWS",
- "Language": 1,
- "AccountFriendlyName": "AccName",
- "PayeeRef": "",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Status": 1,
- "ConsumerPersonalResList": [
- {
- "ConsumerID": 73896,
- "Title": 1,
- "FirstName": "Darshit",
- "LastName": "Desai",
- "CardDisplayName": "",
- "Gender": "M",
- "DOB": "2021-09-20T15:08:30.7399266+05:30",
- "ConsumerType": 1,
- "Relationship": 1,
- "Passportnumber": "",
- "PassportExpiryDate": "2020-07-03T17:26:06.1076331+05:30",
- "Drivinglicence": "",
- "DrivingLicenceExpiryDate": "2019-08-24T14:15:22Z",
- "Nationalidcardline1": "",
- "Nationalidcardline2": "",
- "NationalIDCardExpiryDate": "2019-08-24T14:15:22Z",
- "Nationality": "",
- "SocialSecurityNumber": "1236",
- "KYCClientReferenceID": "00000000-0000-0000-0000-000000000000",
- "KYCStatusID": 2,
- "ShipmentMethodCode": "BULK044",
- "ExpectedYearlySpend": 0,
- "PersonalIdentificationNumber": "11223456789",
- "TransactionVolume": 0,
- "PurposeofAccount": 0,
- "Occupation": 0,
- "OccupationDescription": "",
- "CountryofBirth": "826(UK)",
- "Citizenship": "826(UK)",
- "OtherDocumentName": "Fire arms",
- "OtherDocumentDetails": "12345dfsmsms",
- "OtherDocumentExpiryDate": "2024-12-21T13:58:03.0734254+05:30"
}
], - "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
}
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
.
DocumentVerificationProcessReq
OK
Bad Request
Internal Server Error
{- "KYCClientReferenceID": "e263edc3-61af-4f38-aabd-4b4998edc9fd",
- "DocumentTypeID": 1,
- "DocumentFrontImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
- "DocumentBackImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "DocumentVerificationStatus": 2,
- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
DVFCProcessReq
OK
Bad Request
Internal Server Error
{- "KYCClientReferenceID": "6e20b947-b8c3-47f7-8c5a-922d682f3dd3",
- "DocumentTypeID": 1,
- "DocumentFrontImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
- "DocumentBackImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
- "SelfieImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "DVFCKYCStatus": 2,
- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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
.
FacialComparisonProcessReq
OK
Bad Request
Internal Server Error
{- "KYCClientReferenceID": "007e6c06-4dc2-487d-8c4b-fa4a58276b8e",
- "SelfieImage": "LzlqLzRBQVFTa1pKUmdBQkFRRUFZQUJnQUFELzJ3QkRBQWdHQmdjR0JRZ0hCd2NKQ1FnS0RCUU5EQXNMREJrU0V3OFVIUm9mSGgwYUhCd2dKQzRuSUNJc0l4d2NLRGNwTERBeE5EUTBIeWM1UFRneVBDNHpOREwvMndCREFRa0pDUXdMREJnTkRSZ3lJUndoTWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qSXlNakl5TWpJeU1qTC93QUFSQ0FCa0FGb0RBU0lBQWhFQkF4RUIvOFFBSHdBQUFRVUJBUUVCQVFFQUFBQUFBQUFBQUFFQ0F3UUZCZ2NJQ1FvTA==",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "FacialComparisonStatus": 2,
- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Returns a list of addresses for the supplied Post Code.
The request information.
OK
Bad Request
Internal Server Error
{- "PostCode": "string",
- "CountryA3Code": "str",
- "SchemeCode": "string",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "AddressResList": [
- {
- "AddressSummary": "WHITLAND ROAD, CARSHALTON, SM51QX",
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "",
- "District": "North Yorkshire",
- "Country": "UK",
- "Postcode": "BD23 1RL",
- "AddressLine1": "101 South Street",
- "AddressLine2": "Nr. Highland",
- "AddressLine3": "Opp. Fun Park",
- "Region": "North West",
- "Organization": "DemoExample Group",
- "ISOCountryCode": "826"
}
], - "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
ProfileGetMobileVerificationCodeRequestInfo
OK
Bad Request
Internal Server Error
{- "ConsumerID": 42603,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Retrieves the specified consumer by their ConsumerID
.
GetSpecificConsumerReq
OK
Bad Request
Internal Server Error
{- "ConsumerID": 21,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "ConsumerID": 21,
- "Status": 1,
- "ConsumerRes": {
- "ConsumerPersonalRes": {
- "ConsumerID": 73896,
- "Title": 1,
- "FirstName": "Darshit",
- "LastName": "Desai",
- "CardDisplayName": "",
- "Gender": "M",
- "DOB": "2021-09-20T15:08:30.7399266+05:30",
- "ConsumerType": 1,
- "Relationship": 1,
- "Passportnumber": "",
- "PassportExpiryDate": "2020-07-03T17:26:06.1076331+05:30",
- "Drivinglicence": "",
- "DrivingLicenceExpiryDate": "2019-08-24T14:15:22Z",
- "Nationalidcardline1": "",
- "Nationalidcardline2": "",
- "NationalIDCardExpiryDate": "2019-08-24T14:15:22Z",
- "Nationality": "",
- "SocialSecurityNumber": "1236",
- "KYCClientReferenceID": "00000000-0000-0000-0000-000000000000",
- "KYCStatusID": 2,
- "ShipmentMethodCode": "BULK044",
- "ExpectedYearlySpend": 0,
- "PersonalIdentificationNumber": "11223456789",
- "TransactionVolume": 0,
- "PurposeofAccount": 0,
- "Occupation": 0,
- "OccupationDescription": "",
- "CountryofBirth": "826(UK)",
- "Citizenship": "826(UK)",
- "OtherDocumentName": "Fire arms",
- "OtherDocumentDetails": "12345dfsmsms",
- "OtherDocumentExpiryDate": "2024-12-21T13:58:03.0734254+05:30"
}, - "ContactRes": {
- "EmailAddress": "darshit.desai@demogroup.com",
- "MobileNumber": "449824320432",
- "MobileNumberCountryCode": "44",
- "MobileNumberISOCountryCode": "",
- "IsMobileVerified": false,
- "AddressRes": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "",
- "District": "North Yorkshire",
- "Country": "UK",
- "Postcode": "BD23 1RL",
- "AddressLine1": "101 South Street",
- "AddressLine2": "Nr. Highland",
- "AddressLine3": "Opp. Fun Park",
- "Region": "North West",
- "Organization": "DemoExample Group",
- "ISOCountryCode": "826"
}
}, - "PayeeReferenceNumber": "string"
}, - "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
}
Retrieves all primary and secondary consumers for the given account.
ListConsumersReq
OK
Bad Request
Internal Server Error
{- "AccountIdentifier": 949838,
- "AccountNumber": "00000570",
- "SortCode": "608370",
- "IBAN": "GB35CNFV60837000000570",
- "BIC": "CNFVGB21XXX",
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "ConsumerID": 73896,
- "Status": 1,
- "ConsumerResList": [
- {
- "ConsumerPersonalRes": {
- "ConsumerID": 73896,
- "Title": 1,
- "FirstName": "Darshit",
- "LastName": "Desai",
- "CardDisplayName": "",
- "Gender": "M",
- "DOB": "2021-09-20T15:08:30.7399266+05:30",
- "ConsumerType": 1,
- "Relationship": 1,
- "Passportnumber": "",
- "PassportExpiryDate": "2020-07-03T17:26:06.1076331+05:30",
- "Drivinglicence": "",
- "DrivingLicenceExpiryDate": "2019-08-24T14:15:22Z",
- "Nationalidcardline1": "",
- "Nationalidcardline2": "",
- "NationalIDCardExpiryDate": "2019-08-24T14:15:22Z",
- "Nationality": "",
- "SocialSecurityNumber": "1236",
- "KYCClientReferenceID": "00000000-0000-0000-0000-000000000000",
- "KYCStatusID": 2,
- "ShipmentMethodCode": "BULK044",
- "ExpectedYearlySpend": 0,
- "PersonalIdentificationNumber": "11223456789",
- "TransactionVolume": 0,
- "PurposeofAccount": 0,
- "Occupation": 0,
- "OccupationDescription": "",
- "CountryofBirth": "826(UK)",
- "Citizenship": "826(UK)",
- "OtherDocumentName": "Fire arms",
- "OtherDocumentDetails": "12345dfsmsms",
- "OtherDocumentExpiryDate": "2024-12-21T13:58:03.0734254+05:30"
}, - "ContactRes": {
- "EmailAddress": "darshit.desai@demogroup.com",
- "MobileNumber": "449824320432",
- "MobileNumberCountryCode": "44",
- "MobileNumberISOCountryCode": "",
- "IsMobileVerified": false,
- "AddressRes": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "",
- "District": "North Yorkshire",
- "Country": "UK",
- "Postcode": "BD23 1RL",
- "AddressLine1": "101 South Street",
- "AddressLine2": "Nr. Highland",
- "AddressLine3": "Opp. Fun Park",
- "Region": "North West",
- "Organization": "DemoExample Group",
- "ISOCountryCode": "826"
}
}, - "PayeeReferenceNumber": "string"
}
], - "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
}
Retrieves the Terms and Conditions for the given account.
The request information.
OK
Bad Request
Internal Server Error
{- "UserAccountType": 1,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "TermsResList": [
- {
- "StartDate": "2021-12-21T00:00:00+05:30",
- "TermName": "ABC",
- "Description": "Test Package1",
- "TermsChangeLockInDays": 10,
- "AgreementCode": "ZWYV2XAZ",
- "UserAccountType": 1
}
], - "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
SetConsumerAsLockoutReq
OK
Bad Request
Internal Server Error
{- "PrimaryConsumerID": 1,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Sets the given consumer's status to Normal (Active), enabling all permitted functionality.
SetConsumerAsNormalReq
OK
Bad Request
Internal Server Error
{- "PrimaryConsumerID": 1,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Sets the given consumer's status to Suspended, preventing any card or account related actions being performed by the consumer.
SetConsumerAsSuspendedReq
OK
Bad Request
Internal Server Error
{- "PrimaryConsumerID": 1,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
UnblockConsumerLoginReq
OK
Bad Request
Internal Server Error
{- "ConsumerID": 21,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
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 Mobile number country code in three-digit ISO 3166-1 numeric code format. |
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. |
OK
Bad Request
Internal Server Error
{- "MobileNumber": "1234567890",
- "MobileNumberISOCountryCode": "826",
- "EmailAddress": "abc@xyz.com",
- "AddressReq": {
- "BuildingNo": "4",
- "BuildingName": "Navigation House",
- "Subbuilding": "",
- "SubStreet": "",
- "Street": "Belmont Wharf",
- "Town": "Skipton",
- "County": "UK",
- "District": "North Yorkshire",
- "ISOCountryCode": "826",
- "Postcode": "BD23 1RL",
- "AddressLine1": "",
- "AddressLine2": "",
- "AddressLine3": "",
- "Region": "",
- "Organization": ""
}, - "ConsumerID": 42603,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "SCARes": {
- "SCAReferenceNumber": "5A376AF7-3AA1-4F63-8F44-B29CF6AC770A",
- "SCAType": 1,
- "AuthorizeOn": "Push",
- "AdditionalData": "You have a new authorisation request.",
- "ExpiryDateTime": "2021-11-12T13:32:32.3497733+05:30",
- "RemainingResendCount": 0,
- "RemainingFailAttempt": 5,
- "SCAIdentification": "",
- "StartDateTime": "2021-11-12T13:27:32.3497733+05:30",
- "Title": "Transfer"
}, - "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
Updates the specified consumer's personal information such as Title, Name, Date of Birth etc.
UpdateConsumerDetailReq
OK
Bad Request
Internal Server Error
{- "CardDisplayName": "",
- "Title": 1,
- "FirstName": "XYZ",
- "LastName": "ABC",
- "Gender": "F",
- "DOB": "2001-12-21T13:58:03.9393328+05:30",
- "Language": "1",
- "Relationship": 1,
- "Nationality": "826",
- "PassportNumber": "",
- "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
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}
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.
VerifyMobileReq
OK
Bad Request
Internal Server Error
{- "VerificationCode": "M248",
- "ConsumerID": 42603,
- "ClientRequestReference": "[ReferenceExample]",
- "CultureID": 1
}
{- "Description": "Success",
- "ResponseCode": "000",
- "ResponseDateTime": "2021-12-21T13:58:02.899",
- "ClientRequestReference": "reference",
- "RequestID": 27194
}