Download OpenAPI specification:Download
This backend API is used to report client actions, add the user context and report action results, allowing detection and response reporting and user profiling.
Report a client action event that occurs in an SDK session
Trigger action has been received and stored successfully.
Bad request
Invalid authentication
Invalid authorization
Rate limit reached
Internal error
{- "session_token": "string",
- "action_type": "transaction",
- "user_id": "string",
- "claimed_user_id": "string",
- "correlation_id": "string",
- "transaction_data": {
- "amount": 120,
- "currency": "USD",
- "reason": "string",
- "transactionDate": 0,
- "payer": {
- "name": "string",
- "bankIdentifier": "string",
- "branchIdentifier": "string",
- "accountNumber": "string"
}, - "payee": {
- "name": "string",
- "bankIdentifier": "string",
- "branchIdentifier": "string",
- "accountNumber": "string"
}
}
}
{- "action_token": "string"
}
Reports the result of an action that a recommendation was issued for. This includes whether the user successfully completed the action, and what type of challenge was given to the user (if any).
Action result has been received and stored successfully.
Bad request
Invalid authentication
Invalid authorization
Rate limit reached
Internal error
{- "action_token": "string",
- "result": "success",
- "user_id": "string",
- "private_user_identifier": "string",
- "challenge_type": "sms_otp"
}
Sets the user context for a client action reported to the SDK. It should be set only after you’ve fully authenticated the user (including, for example, any 2FA that was required).
User Auth has been received and stored successfully.
Bad request
Invalid authentication
Invalid authorization
Rate limit reached
Internal error
{- "user_id": "string",
- "action_token": "string"
}