Uploads end-user related data that has been collected for improved IDV process.
The session must be in created
or started
status.
In this request, only the following fields are mandatory:
providerName
:string
Name of the fingerprinting service provider, max 255 charactersnetwork.ip
:string
Either IPv4 or IPv6 data needs be presentdevice.fingerprint
:string
Device fingerprint, max 255 characters
The rest of the parameters listed below are optional. If there is no data to provide, the parameter should not be included in the payload.
Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Request body signed with the shared secret key
Session id
Name of the company providing the fingerprinting service, max 255 characters
Data about the person being verified
Person's e-mail address entered during the validation
Person's phone number, can include numbers, whitespaces and the "+" sign in front
Data about the network used
Name of the service provider
Service Set Identifier (SSID) value
Service host name
Additional data about the location
IP info. At least one is mandatory!
IPv4 info. Optional if IPv6 info is included
IPv6 info. Optional if IPv4 info is included
Autonomous System Number (ASN) info
Autonomous System Number (ASN)
Name of the organization owning the ASN
Data related to the device used for verification
Device fingerprint, max 255 characters
The Android unique device ID is a combination of 8 digits and letters, followed by a dash and three sets of 4 digits and letters, all letters are lowercase
The Identifier for Vendors (IDFV) code
Device model
Device supplier
Device type
Data related to the browser used for verification
IETF language tag, for example: "es-419", "en-gb", "pl"
Browser user agent, max 255 characters
An integer for the time offset from the UTC, in range from -1440 to +1440 minutes
Data about whether the incognito mode is on
Data related to the audio of the device used for verification
Array of data strings about the audio of the device used for verification, in format of name:string
Data related to the screen of the device used for verification
An integer in range of 1–100000
An integer in range of 1–100000
An integer in range of 1–100000
Data related to the battery of the device used for verification
A float in range of 0.0–1.0
Data about whether the device is charging
Data related to the operating system (OS) of the device used for verification
OS family
OS name
OS platform type, for example "x64", "ARM", "OS/390"
OS version
Collected data posted
API request status
UUID v4 which identifies the verification session
UUID v4 which identifies the attempt
Bad request
Unauthorized
Session not found
Internal server error