Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WorkOS radar API

Radar fraud detection.

WorkOS radar API is one of 41 APIs that WorkOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include radar. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, a changelog, and pricing.

This API exposes 4 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.1, at version 1.0.

Requests are made against 2 base URLs: https://api.workos.com, https://api.workos-test.com.

4 operations 3 paths 2 schemas 1 DELETE2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0
Base URL
https://api.workos.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 2

WorkOS radar API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (access_token). By default, every request must be authenticated.

  • bearer — Your WorkOS API key prefixed with sk. Pass it as a Bearer token: Authorization: Bearer skexample123456789.
  • access_token — An SSO access token returned from the Get a Profile and Token endpoint.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

radar 4

Radar fraud detection.

POST
/radar/attempts
Create an Attempt
RadarStandaloneController_assess body → 200400
PUT
/radar/attempts/{id}
Update a Radar Attempt
RadarStandaloneController_updateRadarAttempt 1 param body → 204400404
POST
/radar/lists/{type}/{action}
Add an Entry to a Radar List
RadarStandaloneController_updateRadarList 2 params body → 200201204400
DELETE
/radar/lists/{type}/{action}
Remove an Entry from a Radar List
RadarStandaloneController_deleteRadarListEntry 2 params body → 204400404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are RadarStandaloneResponse (5 properties), RadarListEntryAlreadyPresentResponse (1 property). Each schema is shown below with its type and property counts.

RadarStandaloneResponse
object
5 properties 3 required
RadarListEntryAlreadyPresentResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workos-radar-api-openapi.yml Raw ↑

Other APIs WorkOS publishes across the network.

WorkOS admin-portal API
WorkOS api_keys API
WorkOS application.client-secrets API
WorkOS applications API
WorkOS audit-logs API
WorkOS authorization API
WorkOS connections API
WorkOS directories API
WorkOS directory-groups API
WorkOS directory-users API
WorkOS events API
WorkOS feature-flags API