Update Form Address userForensics

5 min

Update forensics of form updation must be ideally called after every step(identity/bank account/address/documents/fatca/signature/photo/video/contract) of the onboarding flow is complete in order to collect user forensics corresponding to the step.

Endpoint

/api/onboardings/updateForm

Headers

Property	Value
Content-type	application/json
Authorization	…access token… (alphanumeric string of length 64)

Input

Property	Data Type	Example Values
merchantId	String (Required) alphanumeric string of length 24	userId from the investor login response field
save	Enum String (*Required)	“formData”
type	Enum String (*Required)	“userForensics”
data	Object (*Required)	forensics data payload
–type	Enum String (*Required)	“usersData”
–userData	Object (*Required)	contains forensics data grouped by steps (identity/bankaccount/address/documents/fatca/signature/photo/video/contract) in the onboarding flow

{
    "merchantId": ".......",
    "save": "formData",
    "type": "userForensics",
    "data": {
        "type": "usersData",
        "userData": {
            "identity": {
                "geoLocationData": {},
                "browserData": {
                    "browserName": ".....",
                    "cookieEnabled": ".......",
                    "browserLanguage": ".......",
                    "os": "......",
                    "userAgent": ".......",
                    "pluginsInstalled": ["...."],
                    "browserVersion": ".......",
                    "screenWidth": ".......",
                    "screenHeight": ".......",
                    "screenPixelDepth": ".......",
                    "screenColorDepth": ".......",
                    "deviceInfo": {
                        "complete_device_name": ".......",
                        "form_factor": ".......",
                        "is_mobile": false
                    },
                    "signzyPlatformUsed": ".......",
                    "userLat": 12.9833,
                    "userLong": 77.5833
                },
                "pageName": "......."
            },
            "address": {
                "geoLocationData": {},
                "browserData": {
                    "browserName": ".......",
                    "cookieEnabled": ".......",
                    "browserLanguage": ".......",
                    "os": ".......",
                    "userAgent": ".......",
                    "pluginsInstalled": ["...."],
                    "browserVersion": ".......",
                    "screenWidth": ".......",
                    "screenHeight": ".......",
                    "screenPixelDepth": ".......",
                    "screenColorDepth": ".......",
                    "deviceInfo": {
                        "complete_device_name": ".......",
                        "form_factor": ".......",
                        "is_mobile": false
                    },
                    "signzyPlatformUsed": ".......",
                    "userLat": 12.9833,
                    "userLong": 77.5833
                },
                "pageName": "......."
            },
            "bankaccount": {
                "geoLocationData": {},
                "browserData": {
                    "browserName": ".......",
                    "cookieEnabled": ".......",
                    "browserLanguage": ".......",
                    "os": ".......",
                    "userAgent": ".......",
                    "pluginsInstalled": ["...."],
                    "browserVersion": ".......",
                    "screenWidth": ".......",
                    "screenHeight": ".......",
                    "screenPixelDepth": ".......",
                    "screenColorDepth": ".......",
                    "deviceInfo": {
                        "complete_device_name": ".......",
                        "form_factor": ".......",
                        "is_mobile": false
                    },
                    "signzyPlatformUsed": ".......",
                    "userLat": 12.9833,
                    "userLong": 77.5833
                },
                "pageName": "......."
            }
        }
    }
}

UserForensics object has 3 top-level entries i.e geoLocationData, browserData, pageName, the description of userForensics object is as follows:

Property	Data Type	Example Values
geoLocationData	Object (Optional)	Object as fetched from https://ipapi.co/jsonp
pageName	Enum String (Optional)	corresponding page’s name (identity/bankaccount/address/documents/fatca/signature/photo/video/contract)
browserData	Object (Optional)	Details about the browser used
–browserName	String (Optional)	Name of browser (can be extracted from browser’s global navigator.userAgent Object)
–cookieEnabled	String (Optional)	whether cookie is enabled (source: navigator.cookieEnabled)
–browserLanguage	String (Optional)	Language of browser (source: navigator.language)
–os	String (Optional)	OS, browser is running on (source: navigator.platform)
–userAgent	String (Optional)	User Agent of browser (source: navigator.userAgent)
–pluginsInstalled	Array of strings (Optional)	List of plugin names in browser (source: navigator.plugins)
–browserVersion	String (Optional)	Version of browser (can be extracted from navigator.userAgent)
–screenWidth	String (Optional)	Screen width of browser (can be extracted from browser’s global screen Object)
–screenHeight	String (Optional)	Screen height of browser (can be extracted from browser’s global screen Object)
–screenPixelDepth	String (Optional)	Screen pixel depth of browser (can be extracted from browser’s global screen Object)
–screenColorDepth	String (Optional)	Screen color depth of browser (can be extracted from browser’s global screen Object)
–signzyPlatformUsed	Enum String (Optional)	'Mobile’ / 'Desktop’
–userLat	Decimal (Optional)	Geolocation latitude
–userLong	Decimal (Optional)	Geolocation Longitude
–deviceInfo	Object (Optional)	Browser Info as fetched from https://wurfl.io/wurfl.js

Expected Output

{
    "object": "Updated Successfully"
}

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].