Documentation
  • Overview
  • How It Works
  • Developer API
    • Introduction
    • Initial Test
    • Setup
    • JS SDK
    • HTTPS API
      • Identity
      • Identity Status
      • Signal
    • Webhook
    • User Involvement
    • Bans
    • Boilerplates
      • Node.js
    • Types
      • Identity
      • Signal
      • Event
        • Type
        • Level
        • EventSignal
        • Recommendation
          • Ban
            • Action
          • Type
      • ImmediateResult
      • Identifiers
      • Device
      • Location
      • Carrier
      • IP
      • Tor
      • VPN
      • Approvable
Powered by GitBook
On this page
  • Endpoint
  • Methods
  • GET
  1. Developer API
  2. HTTPS API

Identity Status

Check whether a user has opted into DFend.

PreviousIdentityNextSignal

Last updated 2 years ago

Endpoint

https://api.dfend.app/identity-status

Accepts requests from client or server environments (publishable or secret API key).

Methods

GET

Check whether a user has opted into DFend.

Accepts

body object An object containing one of the following fields:

  • userId string The user's primary key or unique ID in your system.

  • id string The id value of the user's in DFend.

Returns

A JSON-encoded object containing the following fields:

  • optedIn boolean Whether the user has opted into DFend.

Identity