The information required to be provided in any API request that requires risk assessment and revenue assurance
Basic Risk Assessment object
| Name | Type | Mandatory | Comment | |
|---|---|---|---|---|
| currentService | string | no | The service to which the transaction relates, e.g. the accountId being recharged | Expected in most cases, however, accountId may be irrelevant for merchant Shop |
| channel | string | yes | The channel (medium) from which the transaction was originated ; Please see the table below for the different expected values for channels; the value is case insensitive | |
| deviceFingerprint | string | yes | A unique identifier of the device from which the request is being made | IVR should send device identifier or caller id |
| ipAddress | string | yes | The IP address of the device from which the is being submitted | |
| geolocationCountry | string | yes | The country from which the function is being requested. 2 character ISO stand country code | |
| geolocation | string | yes | The geographic coordinates of the device from which the request is being submitted | The longitude and latitude of the device |
| activationDate | date | yes | The date upon which the service was activated for the current owner | Expected for all activated services. The date must occur in the past. It May be null to accommodate yet-to-be-activated or not applicable services e.g. Activation or Shop |
| simNumber | string | no | The SIM number to which the function relates | Only applicable to Activation |
| application | object | no | The details of the mechanism (browser, app, OS) through which the request is submitted | |
application[name] | string | no | The name of the application through which the request is submitted | E.g. Chrome, MOA etc |
application[version] | string | no | The version of the application through which the request is submitted | E.g. Version 67.0.3396.99 (Official Build) (64-bit) |
application[osName] | string | no | The OS on which the application is running through which the request is submitted | E.g. iOS, Android, Windows |
application[osVersion] | string | no | The OS version on which the application is running through which the request is submitted | E.g. Windows 7 Professional SP 1 |
| lastInteraction | string | no | The date and time of the last interaction that merchant had with the customer | The timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ |
| expiry | string | no | The date upon which the present service expires | merchant to provide the expiry date/time of the current service. Null indicates no current expiry (i.e. Activation). May be the historical date (expired service) or future dated. The timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ |
| parentAccount | string | yes | Reference to the parent account to which the current service belongs | Represents a hierarchical parent account identifier. May be used for identification of 'family' accounts. In the event that the parent is not known or there is no parent, it should be the same as the current account |
Channel: The medium customers used for tokenisation, reserve funds or payment. Example: SMS, app, web, msite
| Channel | Expected Value to be passed in the API | Comment |
|---|---|---|
| mobile app | app | any request initiated from the mobile app |
| sms | sms | ant requests initiated through sms eg: link - Menu 9999:3 |
| ivr | ivr | any request initiated via ivr |
| web | web | any requests initiated from a desktop version of web portal |
| mobile optimised website | msite | any request initiated through the mobile optimised version of any website |
| Auto Payment | autopayment | Auto payment execution without any manual interruption by customer/merchant |
Sample Example
Simple version of Risk Assessment object
{
"currentService": "61401200106",
"channel": "SMS",
"deviceFingerprint": "fff28a21349c32b326218ebac9f411e",
"ipAddress": "192.168.0.1",
"geolocationCountry": "AU",
"geolocation": "-37.840935,144.946457",
"activationDate": "20-10-2019",
"simNumber":"77666655555",
"application": {
"name": "Chrome",
"version": "Version 67.0.3396.99 (Official Build) (64-bit)",
"osName": "Android",
"osVersion": "Android 9"
},
"lastInteraction": "2019-05-01T03:00:00Z",
"expiry": "2020-02-16T00:00:00Z",
"parentAccount": "61401200106"
}