/v1/sessions/{id}/collected-data

Post
/v1/sessions/{id}/collected-data

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 characters
  • network.ip: string Either IPv4 or IPv6 data needs be present
  • device.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.



Security
API Key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired

Request body signed with the shared secret key

Path parameters
id
stringRequired

Session id

Body parameters
Expand All
object
providerName
string Required

Name of the company providing the fingerprinting service, max 255 characters

ExampleSampleName
person
object

Data about the person being verified

email
string

Person's e-mail address entered during the validation

Examplefirstname.lastname@domain.com
phoneNumber
string

Person's phone number, can include numbers, whitespaces and the "+" sign in front

Example+11 222 333 44
network
object Required

Data about the network used

mobileCarrier
string

Name of the service provider

ExampleRandomTeleCom Inc
ssid
string

Service Set Identifier (SSID) value

Example12345
hostname
string

Service host name

Exampleexamplehostname.amazonaws.com
location
object

Additional data about the location

ip
object Required

IP info. At least one is mandatory!

addressV4
string

IPv4 info. Optional if IPv6 info is included

Example192.168.XXX.XXX
addressV6
string

IPv6 info. Optional if IPv4 info is included

Example2001:DB8:0000:XXXX:XXX:17FF:FEB6:XXXX/64
asn
object

Autonomous System Number (ASN) info

number
string

Autonomous System Number (ASN)

ExampleAS12345
organisation
string

Name of the organization owning the ASN

ExampleAWS
device
object Required

Data related to the device used for verification

fingerprint
string Required

Device fingerprint, max 255 characters

Example123456asdfg7890hijkl123456asdfg7890hijkl123456asdfg7890hijkl
androidId
string

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

Exampleab1357cd-a1b2-c3d4-f5g6
idfv
string

The Identifier for Vendors (IDFV) code

ExampleF325G3GB-12FC-352F-C6C3-DZ52F0F690D8
model
string

Device model

ExampleSamsung Galaxy S23 Ultra
vendor
string

Device supplier

ExampleSamsung
type
string

Device type

Valid values[ "desktop", "mobile", "tablet", "other" ]
Examplemobile
browser
object

Data related to the browser used for verification

languages
Array

IETF language tag, for example: "es-419", "en-gb", "pl"

Example[ "en-gb" ]
userAgent
string

Browser user agent, max 255 characters

timezoneOffsetMinutes
number (integer)

An integer for the time offset from the UTC, in range from -1440 to +1440 minutes

Example-240
isIncognito
boolean

Data about whether the incognito mode is on

ExampleFalse
audio
object

Data related to the audio of the device used for verification

devices
Array of string

Array of data strings about the audio of the device used for verification, in format of name:string

string
screen
object

Data related to the screen of the device used for verification

heightPixels
number (integer)

An integer in range of 1–100000

Example3088
widthPixels
number (integer)

An integer in range of 1–100000

Example1440
dpi
number (integer)

An integer in range of 1–100000

Example500
battery
object

Data related to the battery of the device used for verification

level
number (float)

A float in range of 0.0–1.0

Example0.43
charging
boolean

Data about whether the device is charging

ExampleTrue
os
object

Data related to the operating system (OS) of the device used for verification

family
string

OS family

ExampleAndroid
name
string

OS name

ExampleAndroid
platform
string

OS platform type, for example "x64", "ARM", "OS/390"

version
string

OS version

Example13
Responses
200

Collected data posted

object
status
string

API request status

Examplesuccess
sessionId
string

UUID v4 which identifies the verification session

Examplef04bdb47-d3be-4b28-b028-a652feb060b5
attemptId
string

UUID v4 which identifies the attempt

Examplef5c68aea-7f4d-478d-80ab-ca9356074f69
400

Bad request

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleValidation failed
401

Unauthorized

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
404

Session not found

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleResource not found
500

Internal server error

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleSomething went wrong