Skip to content
SafetyKit
StatusSupportDashboard
API Reference

Data

Ingest data for fraud detection and risk analysis.

Add data
POST/v1/data/{namespace}
Add large batch of data
POST/v1/data/{namespace}/import
Get request status
GET/v1/data/{namespace}/requests/{requestId}
Update namespace settings
PUT/v1/data/{namespace}/settings
ModelsExpand Collapse
DataAddResponse object { requestId, status }

Response confirming data was accepted for asynchronous processing. The requestId can be used for debugging and tracking.

requestId: string

Unique identifier for tracking this request. Data processing happens asynchronously after this response.

status: "accepted"

Request was accepted for processing

DataImportResponse object { expires_at, objectKey, requestId, 2 more }

Response containing an upload URL and metadata for large-batch import processing. Use PUT {upload_url} to upload JSONL (one JSON object per line). upload_url expires in 12 hours.

expires_at: string

ISO timestamp when upload_url expires (12 hours after issuance)

objectKey: string

S3 object key where uploaded JSONL will be processed from

requestId: string

Unique identifier for this import request

status: "pending_upload"

Import request is waiting for file upload

upload_url: string

Pre-signed upload URL for PUT-ing JSONL content (Content-Type: application/json)

DataGetStatusResponse = object { data, namespace, request_id, status } or object { data_count, data_expires_at, data_url, 3 more }

Response containing request status and processed output data.

One of the following:
DataGetRequestAddOutput object { data, namespace, request_id, status }
data: array of object { id, output, url, metadata }
id: string

Object identifier from the ingested data

output: object { actions, fields, labels }
actions: array of unknown
fields: map[unknown]
labels: array of object { label }
label: string
url: string
metadata: optional map[unknown]
namespace: string
request_id: string
status: "queued" or "uploading" or "ingesting" or 2 more
One of the following:
"queued"
"uploading"
"ingesting"
"succeeded"
"failed"
DataGetRequestImportOutput object { data_count, data_expires_at, data_url, 3 more }
data_count: number
minimum0
data_expires_at: string
data_url: string
namespace: string
request_id: string
status: "queued" or "uploading" or "ingesting" or 2 more
One of the following:
"queued"
"uploading"
"ingesting"
"succeeded"
"failed"
DataUpdateSettingsResponse object { namespace, status }

Namespace configuration was stored.

namespace: string
status: "updated"