Skip to content
Tunic Pay Documentation

Start a new session

POST
/app/{appId}/sessions

Starts a new Prevent session by submitting the entrypoint challenge. Returns a sessionId plus the second challenge (if relevant) or a user report.

Parameters

Path Parameters

appId
required

Application identifier

string

Request Body required

Request body for creating a new session

object
entryPoint
object
entity
string
field
required
string
dType
required
string
nullable
Allowed values: text datetime price number url contact location account doc screenshot photo
investigation
required

InvestigationDefinitionLocator with data required to identify an InvestigationDefinition uniquely (id) and semantically (category and subCategories).

object
definitionId
string format: uuid
category
string
subCategories
Array<string>
qResponse
One of:
object
cType
string
Allowed values: price
value
string
/^\d+\.\d{2}$/

Responses

201

One of:

Next challenge to complete

object
id

UUID of the newly created session

string format: uuid
locator

Uniquely identifies a challenge presented to a user within a session.

The investigationId and field describe what data was requested from the user in the challenge.

object
challengeId
string format: uuid
investigationId
string format: uuid
field
string