Create Individual Session

Create a new session for an individual.

Path parameters

entityIdstringRequired
Unique identifier for an entity

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-ChannelstringOptional
Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.
X-Frankie-UsernamestringOptional
Username provided by API caller

Request

This endpoint expects an object.
sessionobjectRequired

Response

OK
requestIdstring
The unique request identifier for the API call made.
sessionobject
Session data for an activity, this is always scoped to a singular entity.

Errors