API Reference: /fingerprint/ingest
This section provides technical reference details for the endpoint, including schemas and response codes.
Endpoint Summary
Property
Value
Description
Accepts a Fingerprint request ID and user context to initiate asynchronous data prefetching.
Authentication
Required: X-API-Key HTTP Header
API Overview
Fingerprint
Transaction Scoring
Customer Management
Request Schema
Required Headers
Header
Type
Description
X-API-Key
string
Subscriber's secret key for authentication.
Request body (application/json)
Field
Type
Required
Description
request_id
string
Yes
The unique FingerprintJS request ID.
subscriber_id
string
Yes
The ID of the subscriber making the request.
session_id
string
Yes
The session ID associated with the user interaction.
user_id
string
Yes
The user ID associated with the transaction.
Response Codes and Payloads
Status Code
Description
Success / Error
Payload Structure
202 Accepted
Request validated and prefetching initiated.
Yes
{"status": "accepted", "mode": "...", "redis_keys": ["..."]}
400 Bad Request
The request body is missing a mandatory field or is invalid JSON.
Yes
{"error": "Missing '...' in request body"}
401 Unauthorized
Missing or invalid API Key in the X-API-Key header.
Yes
{"error": "Missing API key"} or {"error": "Invalid API key"}
500 Internal Server Error
An unexpected exception occurred during processing.
Yes
{"error": "..."}
Success Response Body (202)
Field
Type
Description
status
string
Always accepted.
mode
string
Indicates the method used for initiating the asynchronous prefetch process.
redis_keys
array of strings
A list of identifiers for accessing the prefetch results.
user_id
string
The user_id passed in the request.
session_id
string
The session_id passed in the request.
The documentation for your transaction scoring route has been designed as a cohesive client-side guide, focusing only on the inputs, execution, and outputs necessary for your customers to integrate the service. All internal service logic, processing details, and logging are suppressed.
The endpoint will be referenced using your provided host: