Introduction

Welcome to Frogo. One Leap Ahead of Every Threat.
This documentation hub serves as the central API reference for integrating with Frogo’s anti-fraud platform. It provides developers and partners with schemas, event specifications, and technical integration details.

Overall

The Frogo Device Fingerprint Solution enables partners to collect, identify, and analyze device intelligence data through a lightweight JavaScript integration.

Partners have full control over the integration scope and may choose on which pages the fingerprint client should be executed based on their business needs and risk strategy.

Once integrated, the fp.js collects device, browser, network, and behavioral attributes and generates a unique device identifier. The collected fingerprint data is processed by the Frogo platform after it is submitted. The fingerprint data is collected automatically and sent manually by a Partner. Instead, data submission is explicitly initiated by a Partner through the window.aft.send() function, providing full control over when data is sent to Frogo. Upon successful submission, the system returns a requestID and deviceID. The requestID can subsequently be used to retrieve enriched fingerprint data through Frogo REST API by including it in the corresponding API request.

After successful transmission, Frogo processes the collected information and makes it available through REST API endpoints. Partners can retrieve detailed device intelligence data for further analysis and decision-making.

The solution provides:

• Flexible placement of fp.js on partner-defined pages.
• Collection of device, browser, network, and environment attributes.
• Retrieval of fingerprint data through REST APIs.

Terminology

Integration Scopes

The integration schema defines the structure, data flow, and interaction logic between Frogo and External Partner Systems.

Standalone Device Fingerprint Solution Schema

Integration Steps

1. During the integration phase, Frogo provides a JavaScript fingerprint client (fp.js) that must be placed inside the fp.js section of each relevant HTML page on the partner platform. The script initializes the device fingerprinting process and enables communication with the Frogo Anti-Fraud platform.
2. The fingerprint client script URL is generated using the following components: BASE_URL, UUID, and FILE_TYPE parameters. The UUID is generated in the Frogo Backoffice and uniquely identifies the integration instance.
3. To retrieve the current fingerprint session identifier, the following JavaScript method should be used:const sessionId = await window.aft.sid(10000); The function returns the current session ID when it becomes available.

4. The fingerprint data should be explicitly sent to the Frogo platform using the following API method: await window.aft.send(); The method returns device_id and request_id that is needed for REST API request (see № 8 this list) if the fingerprint was successfully transmitted and false if the operation failed or timed out.The window.aft.send() method can be called from anywhere on the page.
   Note! Each call to window.aft.send() is billable and is charged to the client as a separate request.
5. Since the fingerprint client library is loaded asynchronously, partners should implement a waiting mechanism to ensure that the window.aft object and its methods are fully initialized before invoking any API functions.
6. Fingerprint data can be retrieved using the following API endpoint: GET /partners/stats/{request_id} This endpoint allows the partner to obtain fingerprint-related data by passing the request_id returned by the window.aft.send() method (see statement 6 above).
   Note! Calls to this endpoint are not billable and are not charged to the client.
7. The request requires the following parameters:
   • request_id — required path parameter.
   • ak — query parameter. Partner backend API key used for authorization.
8. If the request is processed successfully, the API returns response code 200 with fingerprint data , including browser, operating system, device, session, IP, localization, and risk-related indicators.

9. The successful response may include the following fingerprint data fields, see example:

Error codes

This section describes the most common error responses that can be returned by the API. Each error code indicates a specific type of issue encountered while processing a request, helping clients quickly identify and resolve problems during integration.

• 400 Bad Request
  The request is malformed or contains invalid parameters. Please verify the request syntax and required fields.
• 401 Authorization Error
  Authentication failed or is missing. Ensure that valid authorization credentials are provided.
• 404 Stats Not Found
  The requested statistics could not be found. Verify that the specified resource, identifier, or requested data exists.
• 500 Server Error
  An unexpected error occurred on the server while processing the request. Retry the request later or contact support if the issue persists.

Example Device Fingerprint Client Integration Script

fp.js Template

<script
    src="https://[BASE_URL]/v2/i/[UUID].js?[FILE_TYPE]"
    type="module"
    async
></script>

fp.js for Sandbox

<script
    src="https://f.dev.r1695.frogo-aft.tech/v2/i/{key}.js?file=i"
    type="module"
    async
></script>

fp.js for Prod

<script
    src="https://s.r1695.frogo-aft.tech/v2/i/{key}.js?file=i"
    type="module"
    async
></script>