Evaluate an activity
Evaluate an activity. This may be verification of a financial transaction such as a
deposit, withdrawal, etc or evaluating a platform level login or registration activities for example.
An entity must exist in the frankie system to tie the activity to.
This will return the immediate result of the activity, and then asynchronously the
activity will be processed in the FrankieOne platform.
Authentication
api_keystring
API Key authentication via header
Headers
api_key
Your API key provided by FrankieOne
X-Frankie-CustomerID
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildID
Your Customer Child ID provided by FrankieOne
X-Frankie-Channel
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-Username
Username provided by API caller
Request
This endpoint expects an object.
activity
Input data for activity evaluation.
A session token is an identifier that will link together activities done in the same end user session to identify the grouping of activities that belong together. It is represented in FrankieOne as a ULID but can differ if not FrankieOne generated.
The session token may be provided to tie in the activity to a longer running overall session. There are a few options for session tokens:
* A session token may not be provided. It is optional to provide but there must be configuration in your account to allow this - FrankieOne will generate a session token on your behalf to identify the overarching session, you may then use this for further calls for the extent of the service. This is not recommended when device signals are important to your use case.
* A session token generated on the client side and not registered with FrankieOne. The client can generate some sort of unique ID to identify the session and provide that at the time of call and manage the session token for the duration of the session. This can be used when device signals are required.
* A session token can be generated in a seperate API within FrankieOne - Refer to the `Create Individual Session` API. This will register the session in FrankieOne and tie it to the individual of interest. There is configuration in your account which can enforce session ownership to avoid clients modifying the session token, adding another layer of security. This can be used when device signals are required.
Response
OK
requestId
The unique request identifier for the API call made.
activity
Activity details
