The Husqy premium subscription is now live! Please head over to our Discord store page to get started!
We are verified! Husqy is a verified bot in Discord making us visible in the app discovery and enabling bigger trust to users!
Want to help us translate the Husqy responses? We can't do it without you! Please visit our translations repo!
Skip to main content
API docs by Redocly

Husqy.modules.verifier (2.0.0)

Download OpenAPI specification:Download

Settings

Operations related to the settings of the verifier module

Get The Settings Of The Verifier Module In A Server

Get the settings for Husqy verifier module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete The Settings Of The Verifier Module In A Server

Delete the settings for Husqy verifier module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update The Settings Of The Logging Module In A Server

Change the settings for Husqy verifier module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Verifier Type (integer) or Verifier Type (null) (Verifier Type)
Array of Verifier Verified Role Ids (integers) or Verifier Verified Role Ids (null) (Verifier Verified Role Ids)
Verifier Message Is Embed (boolean) or Verifier Message Is Embed (null) (Verifier Message Is Embed)
Verifier Message Content (string) or Verifier Message Content (null) (Verifier Message Content)
Verifier Channel (integer) or Verifier Channel (null) (Verifier Channel)
Verifier Message Content Completed (string) or Verifier Message Content Completed (null) (Verifier Message Content Completed)
Verifier Passphrase (string) or Verifier Passphrase (null) (Verifier Passphrase)
Verifier Message Completed Is Embed (boolean) or Verifier Message Completed Is Embed (null) (Verifier Message Completed Is Embed)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "verifier_type": 0,
  • "verifier_verified_role_ids": [
    ],
  • "verifier_message_is_embed": true,
  • "verifier_message_content": "string",
  • "verifier_channel": 0,
  • "verifier_message_content_completed": "string",
  • "verifier_passphrase": "string",
  • "verifier_message_completed_is_embed": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Status

Operations related to the status of the verifier module

Get The Status Of The Verifier Module In A Server

Status endpoint for the Husqy.modules.verifier microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Disable The Verifier Module

Enable the verifier module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enable The Verifier Module In A Server

Enable the verifier module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Entries

Operations related to verifier entries

Get All Current Verifier Entries In A Server

Get the entry for Husqy verifier module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Information About A Verifier Entry In A Server

Get the entry for Husqy verifier module for a guild.

path Parameters
entry_id
required
string (Entry Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Events

Operations related to verifier entries

Create A Verification Entry For A New Member

Create a verification for Husqy verifier module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
required
Requester (integer) or Requester (string) (Requester)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "requester": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Handle A Verification Entry For A New Member

Handle a verification for Husqy verifier module for a guild.

Request Body schema: application/json
required
verifier_id
required
string (Verifier Id)
Interaction Id (integer) or Interaction Id (null) (Interaction Id)
Token (string) or Token (null) (Token)
Interaction Type (string) or Interaction Type (null) (Interaction Type)
Passphrase Value (string) or Passphrase Value (null) (Passphrase Value)

Responses

Request samples

Content type
application/json
{
  • "verifier_id": "string",
  • "interaction_id": 0,
  • "token": "string",
  • "interaction_type": "string",
  • "passphrase_value": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Privacy

Operations for a users privacy data

Get The Privacy Data Of A User For The Husqy.Modules.Verifier Microservice

Get user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete The Privacy Data Of A User For The Husqy.Modules.Verifier Microservice

Delete user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Home Endpoint For The Husqy.Modules.Verifier Microservice

Home endpoint for the Husqy.general microservice.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}