POST
/
initiateSession

Query Parameters

apiKey
string
required

The API Key of your account.

data
object
required
CustomerIdentifier
string|integer

A unique value represent the customer (your user).

Samples: "UID123", "123", or 123.

test
boolean

Set this property to true to send the request to the development environment.

Response properties

SessionId
string
required

The created session identifier.

CountryCode
string
required

The country code (depends on your account)

Error Codes

Here’s a list of possible error codes of this endpoint.

CodeDescription
1Missing or invalid api key
2CustomerIdentifier is a required parameter.