ThreatMetrixToken
API documentation for ThreatMetrixToken task type
Supported Providers
| Provider | Price per 1,000 | Routing |
|---|---|---|
| $1.00 |
Request Schema
| Field | Type | Required | Description |
|---|---|---|---|
clientKey* | string | Yes | Your API key. Create one in the AnySolver dashboard. Example: |
task* | object | Yes | The task body. Required fields depend on the task type. See Tasks for per-task schemas. View task properties |
settings | object | No | Per-request settings for routing, auto retry, auto fallback, and proxy behavior. See Routing Strategies. |
provider | No | Specific provider to use. If omitted, automatic routing selects the best provider. Example: | |
selectionMode | No | Routing strategy for this request. Overrides the API key default. See Routing Strategies. Example: | |
keyPoolMode | No | Which provider key pool to use: Example: |
Task Object Properties
The task field accepts an object with the following properties:
| Field | Type | Required | Description |
|---|---|---|---|
type* | Yes | ||
websiteURL* | URL | Yes | Full URL of the page where the CAPTCHA is displayed. Example: |
orgId* | string | Yes | ThreatMetrix organization ID (org_id). Example: |
pageId* | string | Yes | ThreatMetrix page ID for the profiling session. Example: |
sessionId* | string | Yes | ThreatMetrix session ID to fingerprint. Example: |
customDomain* | string | Yes | Custom ThreatMetrix profiling domain. Example: |
title* | string | Yes | Title of the target page (document.title). Example: |
proxy* | string | object | Yes |
Optional fields are not guaranteed across providers
Response Schema
| Field | Type | Required | Description |
|---|---|---|---|
status* | Yes | Task status: "processing", "ready", or "failed". Example: | |
errorId* | Yes | 0 = success, 1 = external error, 2 = internal error. Example: | |
taskId | string | No | Unique identifier returned when the task was created. Example: |
errorCode | No | Machine-readable error code. Example: | |
errorDescription | string | No | Human-readable error message with resolution hints. Example: |
cost | number | No | Actual cost charged for this task in USD. Example: |
taskType | No | The type of CAPTCHA task to solve. Example: | |
provider | No | Specific provider to use. If omitted, automatic routing selects the best provider. Example: | |
solution | object | No |
Solution Object Properties
The solution field contains an object with the following properties:
| Field | Type | Required | Description |
|---|---|---|---|
sessionId* | string | Yes | ThreatMetrix session ID to fingerprint. Example: |
cookies* | Record<string, unknown> | Yes | Session cookies obtained during solving (if applicable). Example: |
userAgent* | string | Yes | User-Agent string used during solving (if applicable). Example: |
raw* | Record<string, unknown> | Yes | Raw provider response data for advanced use cases. |