Paranoidlab API

https://paranoidlab.com/v1/docs
Admin
Paranoidlab API is a data breach monitoring and leak detection service that enables users to monitor...
Tokens:9,923
Snippets:44
Trust Score:7.1
Update:7 months ago
Show doc for...
Tokens:
Raw
### GET /v1/profile

Source: https://paranoidlab.com/v1/docs/index

Retrieves the profile information of the authenticated user.

```APIDOC
## GET /v1/profile

### Description
Retrieves the profile information of the currently authenticated user. This includes account details, subscription plan, and payment status.

### Method
GET

### Endpoint
/v1/profile

### Parameters
No parameters are required for this endpoint.

### Response
#### Success Response (200)
- **email** (string) - The user's email address.
- **date_joined** (string) - The date and time the user joined (ISO 8601 format).
- **has_unpaid_invoices** (boolean) - Indicates if the user has any unpaid invoices.
- **balance** (integer) - The user's account balance.
- **plan** (object) - Details about the user's current plan.
  - **name** (string) - The name of the plan.
  - **billing_type** (string) - The billing type (e.g., 'request').
  - **price** (integer) - The price of the plan.
  - **currency** (string) - The currency of the price (e.g., 'USD').
  - **features** (array) - A list of features included in the plan.
  - **credits** (integer) - The number of credits associated with the plan.
- **subscription** (object) - Details about the user's subscription.
  - **is_cancelled** (boolean) - Indicates if the subscription is cancelled.
  - **start_at** (string) - The start date of the subscription (YYYY-MM-DD).
  - **end_at** (string) - The end date of the subscription (YYYY-MM-DD).
  - **payment_deadline_at** (string) - The payment deadline date (YYYY-MM-DD).
  - **is_active** (boolean) - Indicates if the subscription is currently active.

#### Response Example
```json
{
  "email": "user@example.com",
  "date_joined": "2023-10-27T10:00:00Z",
  "has_unpaid_invoices": false,
  "balance": 100,
  "plan": {
    "name": "Pro Plan",
    "billing_type": "monthly",
    "price": 50,
    "currency": "USD",
    "features": [
      "api",
      "support"
    ],
    "credits": 1000
  },
  "subscription": {
    "is_cancelled": false,
    "start_at": "2023-01-01",
    "end_at": "2024-01-01",
    "payment_deadline_at": "2023-12-25",
    "is_active": true
  }
}
```

#### Error Response (401)
Unauthorized
```

--------------------------------

### Create Target Request Sample

Source: https://paranoidlab.com/v1/docs/index

Example JSON payload for creating a new target. Requires 'type' and 'value', with 'tag' being optional.

```json
{
  "type": "email",
  "value": "string",
  "tag": "default"

}
```

--------------------------------

### GET /v1/telegram/files

Source: https://paranoidlab.com/v1/docs/index

Searches for files in Telegram channels and groups based on keywords and date ranges.

```APIDOC
## GET /v1/telegram/files

### Description
Searches for files shared in Telegram channels and groups. Supports filtering by keyword, date range, and pagination.

### Method
GET

### Endpoint
/v1/telegram/files

### Parameters
#### Query Parameters
- **keyword** (string) - Required - The keyword to search for within file names or content.
- **limit** (integer) - Optional - The maximum number of files to retrieve (default: 20, max: 500).
- **next** (string) - Optional - The pagination token to fetch the next set of results.
- **date_from** (string) - Optional - The start date for filtering files (YYYY-MM-DD).
- **date_to** (string) - Optional - The end date for filtering files (YYYY-MM-DD).

### Request Example
```json
{
  "keyword": "document",
  "limit": 100,
  "date_from": "2023-01-01",
  "date_to": "2023-12-31"
}
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of files found.
- **next** (string) - The token for the next page of results.
- **data** (array) - An array of file objects.

#### Response Example
```json
{
  "total": 50,
  "next": "another_pagination_token",
  "data": [
    {
      "file_id": "file_abc123",
      "file_name": "report.pdf",
      "file_type": "pdf",
      "date": "2023-10-26T15:30:00Z"
    }
  ]
}
```

#### Error Response (422)
Unprocessable Entity
```

--------------------------------

### GET /v1/telegram/posts

Source: https://paranoidlab.com/v1/docs/index

Retrieves a list of Telegram posts based on keywords, date ranges, and pagination.

```APIDOC
## GET /v1/telegram/posts

### Description
Retrieves a list of Telegram posts. Supports filtering by keyword, date range, and pagination using the 'next' parameter.

### Method
GET

### Endpoint
/v1/telegram/posts

### Parameters
#### Query Parameters
- **keyword** (string) - Required - The keyword to search for in Telegram posts.
- **limit** (integer) - Optional - The maximum number of posts to retrieve (default: 20, max: 500).
- **next** (string) - Optional - The pagination token to fetch the next set of results.
- **date_from** (string) - Optional - The start date for filtering posts (YYYY-MM-DD).
- **date_to** (string) - Optional - The end date for filtering posts (YYYY-MM-DD).

### Request Example
```json
{
  "keyword": "example",
  "limit": 50,
  "date_from": "2023-01-01",
  "date_to": "2023-12-31"
}
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of posts found.
- **next** (string) - The token for the next page of results.
- **data** (array) - An array of Telegram post objects.

#### Response Example
```json
{
  "total": 100,
  "next": "some_pagination_token",
  "data": [
    {
      "post_id": 12345,
      "text": "This is an example post.",
      "date": "2023-10-27T10:00:00Z"
    }
  ]
}
```

#### Error Response (422)
Unprocessable Entity
```

--------------------------------

### GET /v1/targets

Source: https://paranoidlab.com/v1/docs/index

Retrieve a list of targets associated with the authenticated user. Supports filtering by tag, type, and search, with pagination options.

```APIDOC
## GET /v1/targets

### Description
Retrieve a list of targets associated with the authenticated user. Each target represents an entity such as an email, domain, or telegram, along with its verification status and metadata.

### Method
GET

### Endpoint
/v1/targets

### Query Parameters
- **tag** (string) - Optional - Tag to filter targets.
- **type** (string) - Optional - Type of target (email, domain, ip).
- **search** (string) - Optional - Search string for targets.
- **limit** (integer) - Optional - Number of targets to return per page. Default: 15.
- **offset** (integer) - Optional - Number of targets to skip. Default: 0.

### Responses
#### Success Response (200)
- **items** (array) - List of target objects.
  - **id** (integer) - Unique identifier for the target.
  - **type** (string) - Type of the target (e.g., "email").
  - **value** (string) - The target value (e.g., an email address).
  - **tag** (string) - The tag associated with the target.
  - **is_verified** (boolean) - Indicates if the target is verified.
- **count** (integer) - Total number of targets found.

#### Error Response (401)
Unauthorized

### Response Example (200)
```json
{
  "items": [
    {
      "id": 0,
      "type": "email",
      "value": "string",
      "tag": "string",
      "is_verified": true
    }
  ],
  "count": 0
}
```
```

--------------------------------

### GET /v1/telegram/user

Source: https://paranoidlab.com/v1/docs/index

Retrieves information about a specific Telegram user.

```APIDOC
## GET /v1/telegram/user

### Description
Retrieves detailed information about a specific Telegram user identified by their user ID.

### Method
GET

### Endpoint
/v1/telegram/user

### Parameters
#### Query Parameters
- **user_id** (integer) - Required - The unique identifier of the Telegram user.

### Request Example
```json
{
  "user_id": 123456789
}
```

### Response
#### Success Response (200)
- **user_id** (integer) - The user's unique identifier.
- **username** (string) - The user's username.
- **fullname** (string) - The user's full name.
- **phone** (string) - The user's phone number.
- **bot** (boolean) - Indicates if the user is a bot.
- **scam** (boolean) - Indicates if the user is flagged as a scam.

#### Response Example
```json
{
  "user_id": 123456789,
  "username": "example_user",
  "fullname": "Example User Name",
  "phone": "+1234567890",
  "bot": false,
  "scam": false
}
```

#### Error Response (422)
Unprocessable Entity
```

--------------------------------

### GET /v1/leaks

Source: https://paranoidlab.com/v1/docs/index

Retrieves a list of leaks associated with targets. Includes details like target, leak type, source, date, and device information.

```APIDOC
## GET /v1/leaks

### Description
This endpoint retrieves a list of leaks. Each leak includes details such as the target, leak type, source, date of occurrence, and, if available, device information.

### Method
GET

### Endpoint
/v1/leaks

### Parameters
#### Query Parameters
- **request_id** (integer) - Optional - Filter leaks by request ID.
- **target** (string) - Optional - Filter leaks by target value.
- **target_tag** (string) - Optional - Filter leaks by target tag.
- **type** (string) - Optional - Filter leaks by type. Enum: "password", "cookie", "pii".
- **source** (string) - Optional - Filter leaks by source. Enum: "malware", "combo".
- **data_url** (string) - Optional - Partial search for leaks by data URL.
- **data_user** (string) - Optional - Partial search for leaks by data username.
- **created_at_from** (string) - Optional - Filter leaks created on or after this date.
- **created_at_to** (string) - Optional - Filter leaks created before this date.
- **risk_level** (string) - Optional - Show only leaks with a risk level greater than or equal to the specified value.
- **limit** (integer) - Optional - Maximum number of leaks to return. Default: 15.
- **offset** (integer) - Optional - Number of leaks to skip. Default: 0.

### Response
#### Success Response (200)
- **items** (array) - A list of leak objects.
  - **id** (integer) - The unique identifier for the leak.
  - **request_id** (integer) - The ID of the request associated with the leak.
  - **target** (string) - The target associated with the leak.
  - **target_tag** (string) - The tag of the target.
  - **target_type** (string) - The type of the target (e.g., "email").
  - **type** (string) - The type of the leak (e.g., "password", "cookie", "pii").
  - **source** (string) - The source of the leak (e.g., "malware", "combo").
  - **data** (object) - Contains leaked data.
    - **url** (string) - The URL where the data was leaked.
    - **user** (string) - The username associated with the leaked data.
    - **password** (string) - The leaked password.
    - **cookie** (array) - A list of leaked cookies.
  - **created_at** (string) - The timestamp when the leak was created.
  - **uploaded_at** (string) - The timestamp when the leak was uploaded.
  - **risk** (object) - Information about the risk level of the leak.
    - **level** (string) - The risk level (e.g., "low", "medium", "high").
    - **score** (integer) - A numerical score representing the risk.
  - **date** (string) - The date of the leak.
  - **device** (object) - Information about the device associated with the leak.
    - **ip** (string) - The IP address of the device.
    - **os** (string) - The operating system of the device.
    - **user** (string) - The username on the device.
    - **country** (string) - The country of the device location.
    - **location** (string) - The specific location of the device.
    - **zip** (string) - The zip code of the device location.
    - **comp_name** (string) - The computer name.
    - **malware_path** (string) - The path of the malware on the device.
    - **antiviruses** (array) - A list of antivirus programs detected on the device.
- **count** (integer) - The total number of leaks found.

#### Error Responses
- **401** Unauthorized

#### Response Example (Success)
```json
{
  "items": [
    {
      "id": 0,
      "request_id": 0,
      "target": "string",
      "target_tag": "string",
      "target_type": "email",
      "type": "password",
      "source": "malware",
      "data": {
        "url": "",
        "user": "",
        "password": "",
        "cookie": []
      },
      "created_at": "2019-08-24T14:15:22Z",
      "uploaded_at": "2019-08-24T14:15:22Z",
      "risk": {
        "level": "low",
        "score": 0
      },
      "date": "2019-08-24",
      "device": {
        "ip": "",
        "os": "",
        "user": "",
        "country": "",
        "location": "",
        "zip": "",
        "comp_name": "",
        "malware_path": "",
        "antiviruses": []
      }
    }
  ],
  "count": 0
}
```
```

--------------------------------

### 401 Unauthorized Error Response

Source: https://paranoidlab.com/v1/docs/index

Example of a 401 Unauthorized error response. This signifies that the request is missing valid authentication credentials, such as an API key.

```json
{
    "detail": "{error}"
}
```

--------------------------------

### 400 Bad Request Error Response

Source: https://paranoidlab.com/v1/docs/index

Example of a 400 Bad Request error response. This indicates an issue with the request's syntax or data that the server could not understand.

```json
{
  "detail": "{error}"
}
```

--------------------------------

### GET /v1/leaks/requests

Source: https://paranoidlab.com/v1/docs/index

Retrieves the history of leak-checking requests. Provides information about the status, target, sources, cost, timestamps, and errors for each request.

```APIDOC
## GET /v1/leaks/requests

### Description
Retrieves the history of leak-checking requests. It provides information about the status of each request, the target being checked, the sources used, the cost in credits, and timestamps for creation and execution. It also includes any errors encountered during the request processing.

### Method
GET

### Endpoint
/v1/leaks/requests

### Parameters
#### Query Parameters
- **status** (string) - Optional - Enum: "pending", "running", "completed", "error"
- **target** (string) - Optional
- **limit** (integer) - Optional - Minimum value: 1 - Default: 15
- **offset** (integer) - Optional - Minimum value: 0 - Default: 0

### Responses
#### Success Response (200)
OK
- **items** (array) - List of leak request objects.
  - **id** (integer) - Unique identifier for the request.
  - **status** (string) - The current status of the request (e.g., "pending", "completed").
  - **target** (string) - The target that was checked.
  - **target_type** (string) - The type of the target (e.g., "email").
  - **target_tag** (string) - A tag associated with the target.
  - **leak_types** (array of strings) - Types of leaks checked (e.g., "password").
  - **cost** (integer) - The cost in credits for this request.
  - **leaks_fetched** (integer) - The number of leaks fetched.
  - **enqueued_at** (string) - Timestamp when the request was enqueued.
  - **executed_at** (string) - Timestamp when the request was executed.
  - **from_date** (string) - The start date for the leak check.
  - **error** (string) - Any error message if the request failed.
- **count** (integer) - The total number of requests matching the query.

#### Error Response (401)
Unauthorized

### Response Example (200)
```json
{
  "items": [
    {
      "id": 0,
      "status": "pending",
      "target": "string",
      "target_type": "email",
      "target_tag": "string",
      "leak_types": [
        "password"
      ],
      "cost": 0,
      "leaks_fetched": 0,
      "enqueued_at": "2019-08-24T14:15:22Z",
      "executed_at": "2019-08-24T14:15:22Z",
      "from_date": "2019-08-24T14:15:22Z",
      "error": ""
    }
  ],
  "count": 0
}
```
```

--------------------------------

### GET /v1/targets/{id}

Source: https://paranoidlab.com/v1/docs/index

Retrieves the details of a specified target by its unique ID. Includes information like type, value, verification status, and last checked time.

```APIDOC
## GET /v1/targets/{id}

### Description
This endpoint retrieves the details of a specified target by its unique ID. The response includes information such as the target's type, value, verification status, and last checked time.

### Method
GET

### Endpoint
/v1/targets/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Target ID for retrieval.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the target.
- **type** (string) - The type of the target (e.g., "email").
- **value** (string) - The value of the target.
- **tag** (string) - The tag associated with the target.
- **is_verified** (boolean) - Indicates if the target is verified.

#### Error Responses
- **401** Unauthorized
- **404** Not Found

#### Response Example (Success)
```json
{
  "id": 0,
  "type": "email",
  "value": "string",
  "tag": "string",
  "is_verified": true
}
```
```

--------------------------------

### POST /v1/leaks/fetch

Source: https://paranoidlab.com/v1/docs/index

Triggers a request to retrieve new leaks for a specified target, starting from the last checked date. Adds a task to the queue for processing leaks against a list of sources. Each unique source checked costs 1 credit. If the notify flag is true, a notification will be sent upon completion.

```APIDOC
## POST /v1/leaks/fetch

### Description
Triggers a request to retrieve new leaks for a specified target, starting from the last checked date. The request will add a task to the queue for processing the leaks, which are checked against a list of sources. Each unique source checked costs 1 credit. If the notify flag is set to true, a notification about new leaks will be send.

### Method
POST

### Endpoint
/v1/leaks/fetch

### Parameters
#### Request Body
- **target_id** (integer) - Required - The ID of the target to fetch leaks for.
- **leak_types** (array of strings) - Optional - Default: [] - Items Enum: "password", "cookie", "pii". If omitted or left empty, all leak types will be downloaded.
- **notify** (boolean) - Optional - Default: true - Notify via email when the request is completed.

### Request Example
```json
{
  "target_id": 0,
  "leak_types": [],
  "notify": true
}
```

### Responses
#### Success Response (200)
OK
- **request_id** (integer) - The ID of the created request.
- **status** (string) - The initial status of the request (e.g., "pending").
- **cost** (integer) - The estimated cost of the request in credits.

#### Error Response (400)
Bad Request

#### Error Response (401)
Unauthorized

#### Error Response (404)
Not Found

#### Error Response (422)
Unprocessable Entity

### Response Example (200)
```json
{
  "request_id": 0,
  "status": "pending",
  "cost": 0
}
```
```

--------------------------------

### Get Target Response (JSON)

Source: https://paranoidlab.com/v1/docs/index

Retrieves detailed information about a specific target, identified by its unique ID. The response is in JSON format and includes details like type, value, verification status, and associated tags.

```json
{
  "id": 0,
  "type": "email",
  "value": "string",
  "tag": "string",
  "is_verified": true
}
```

--------------------------------

### GET /v1/leaks/requests/{id}

Source: https://paranoidlab.com/v1/docs/index

Retrieves details of a specific leak-checking request by its ID. Allows checking the status, target, sources, cost, and errors of a request, along with creation and execution timestamps.

```APIDOC
## GET /v1/leaks/requests/{id}

### Description
Retrieves details of a specific leak-checking request by its ID. It allows to check the status of the request, including information on the target, sources, cost, and any errors encountered during the process. The response also includes timestamps for when the request was created and executed.

### Method
GET

### Endpoint
/v1/leaks/requests/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the request.

### Responses
#### Success Response (200)
OK
- **id** (integer) - Unique identifier for the request.
- **status** (string) - The current status of the request (e.g., "pending", "completed").
- **target** (string) - The target that was checked.
- **target_type** (string) - The type of the target (e.g., "email").
- **target_tag** (string) - A tag associated with the target.
- **leak_types** (array of strings) - Types of leaks checked (e.g., "password").
- **cost** (integer) - The cost in credits for this request.
- **leaks_fetched** (integer) - The number of leaks fetched.
- **enqueued_at** (string) - Timestamp when the request was enqueued.
- **executed_at** (string) - Timestamp when the request was executed.
- **from_date** (string) - The start date for the leak check.
- **error** (string) - Any error message if the request failed.

#### Error Response (401)
Unauthorized

#### Error Response (404)
Not Found

### Response Example (200)
```json
{
  "id": 0,
  "status": "pending",
  "target": "string",
  "target_type": "email",
  "target_tag": "string",
  "leak_types": [
    "password"
  ],
  "cost": 0,
  "leaks_fetched": 0,
  "enqueued_at": "2019-08-24T14:15:22Z",
  "executed_at": "2019-08-24T14:15:22Z",
  "from_date": "2019-08-24T14:15:22Z",
  "error": ""
}
```
```

--------------------------------

### 422 Unprocessable Entity Error Response

Source: https://paranoidlab.com/v1/docs/index

Example of a 422 Unprocessable Entity error response. This occurs when the server understands the request but cannot process it due to semantic errors, often related to field validation.

```json
{
    "detail": "{error}"
    "field": "{field}"
}
```

--------------------------------

### GET /v1/leaks/{id}

Source: https://paranoidlab.com/v1/docs/index

Retrieves details of a specific leak by its ID. Provides information about the target, leak type, source, and associated metadata, including the date it occurred and any additional details.

```APIDOC
## GET /v1/leaks/{id}

### Description
Retrieves details of a specific leak by its ID. It provides information about the target, leak type, source, and associated metadata. This allows the user to view the specifics of a particular leak, including the date it occurred and any additional details related to the leak.

### Method
GET

### Endpoint
/v1/leaks/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the leak.

### Responses
#### Success Response (200)
OK
- **id** (integer) - Unique identifier for the leak.
- **request_id** (integer) - The ID of the request that generated this leak.
- **target** (string) - The target associated with the leak.
- **target_tag** (string) - A tag associated with the target.
- **target_type** (string) - The type of the target (e.g., "email").
- **type** (string) - The type of the leak (e.g., "password").
- **source** (string) - The source where the leak was found.
- **data** (object) - Object containing leak data.
  - **url** (string) - URL associated with the leak.
  - **user** (string) - Username associated with the leak.
  - **password** (string) - Password found in the leak.
  - **cookie** (array) - Cookies associated with the leak.
- **created_at** (string) - Timestamp when the leak was created.
- **uploaded_at** (string) - Timestamp when the leak was uploaded.
- **risk** (object) - Risk assessment of the leak.
  - **level** (string) - The risk level (e.g., "low").
  - **score** (integer) - The risk score.
- **date** (string) - The date the leak occurred.
- **device** (object) - Information about the device associated with the leak.
  - **ip** (string) - IP address.
  - **os** (string) - Operating system.
  - **user** (string) - Device username.
  - **country** (string) - Country.
  - **location** (string) - Location.
  - **zip** (string) - ZIP code.
  - **comp_name** (string) - Company name.
  - **malware_path** (string) - Malware path.
  - **antiviruses** (array) - List of antiviruses detected.

#### Error Response (401)
Unauthorized

#### Error Response (422)
Unprocessable Entity

### Response Example (200)
```json
{
  "id": 0,
  "request_id": 0,
  "target": "string",
  "target_tag": "string",
  "target_type": "email",
  "type": "password",
  "source": "malware",
  "data": {
    "url": "",
    "user": "",
    "password": "",
    "cookie": []
  },
  "created_at": "2019-08-24T14:15:22Z",
  "uploaded_at": "2019-08-24T14:15:22Z",
  "risk": {
    "level": "low",
    "score": 0
  },
  "date": "2019-08-24",
  "device": {
    "ip": "",
    "os": "",
    "user": "",
    "country": "",
    "location": "",
    "zip": "",
    "comp_name": "",
    "malware_path": "",
    "antiviruses": []
  }
}
```
```

--------------------------------

### Create Target Response Sample (200 OK)

Source: https://paranoidlab.com/v1/docs/index

Sample JSON response for successfully creating a target. It includes the target's details, and potentially a verification token for domain targets.

```json
{
  "id": 0,
  "type": "email",
  "value": "string",
  "tag": "string",
  "is_verified": true,
  "token": "string"

}
```

--------------------------------

### POST /v1/targets/create

Source: https://paranoidlab.com/v1/docs/index

Creates a new target for the user. Supports auto-verification and requires specific DNS TXT record for domain targets.

```APIDOC
## POST /v1/targets/create

### Description
This endpoint creates a new target for the user. If auto-verification is enabled, no additional steps are required for verification. For domain targets, the returned token must be added as a `_token={token}` TXT record in the DNS. For IP targets, the IP feature must be present in the subscription.

### Method
POST

### Endpoint
/v1/targets/create

### Request Body
- **type** (string) - Required - Type of target (Enum: "email", "domain", "ip").
- **value** (string) - Required - The value of the target (e.g., email address, domain name).
- **tag** (string) - Optional - Tag for the target. Minimum 3 characters. Default: "default".

### Request Example
```json
{
  "type": "email",
  "value": "string",
  "tag": "default"
}
```

### Responses
#### Success Response (200)
- **id** (integer) - Unique identifier for the created target.
- **type** (string) - Type of the target.
- **value** (string) - The target value.
- **tag** (string) - The tag associated with the target.
- **is_verified** (boolean) - Indicates if the target is verified.
- **token** (string) - Verification token (for domain targets).

#### Error Response (400)
Bad Request

#### Error Response (401)
Unauthorized

#### Error Response (422)
Unprocessable Entity

### Response Example (200)
```json
{
  "id": 0,
  "type": "email",
  "value": "string",
  "tag": "string",
  "is_verified": true,
  "token": "string"
}
```
```

--------------------------------

### Include API Key in HTTP Header

Source: https://paranoidlab.com/v1/docs/index

Demonstrates how to include the API key in the 'X-Key' HTTP header for authentication. This is a common requirement for most API requests to Paranoidlab.

```http
X-Key: {your_api_key}
```

--------------------------------

### POST /v1/targets/verify-domain

Source: https://paranoidlab.com/v1/docs/index

Verifies a domain target by checking for a specific DNS TXT record. This is a crucial step to confirm ownership and validity of a domain.

```APIDOC
## POST /v1/targets/verify-domain

### Description
This endpoint verifies a domain target by checking the presence of a specific DNS TXT record. To verify the domain, a TXT record in the format `_token={token}` must be added to the domain's DNS settings. The `{token}` is the unique verification token provided when the target was created. If the required TXT record is found, the domain will be verified.

### Method
POST

### Endpoint
/v1/targets/verify-domain

### Parameters
#### Request Body
- **id** (integer) - Required - Target ID for verification.

### Request Example
```json
{
  "id": 0
}
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the target.
- **type** (string) - The type of the target (e.g., "email").
- **value** (string) - The value of the target.
- **is_verified** (boolean) - Indicates if the target is verified.

#### Error Responses
- **400** Bad Request
- **422** Unprocessable Entity

#### Response Example (Success)
```json
{
  "id": 0,
  "type": "email",
  "value": "string",
  "is_verified": true
}
```
```

--------------------------------

### Retrieve Targets Response Sample (200 OK)

Source: https://paranoidlab.com/v1/docs/index

Sample JSON response for a successful retrieval of targets. It includes a list of targets, each with its ID, type, value, tag, and verification status.

```json
{
  "items": [
    {
      "id": 0,
      "type": "email",
      "value": "string",
      "tag": "string",
      "is_verified": true
}
],
  "count": 0

}
```

--------------------------------

### Verify Domain Request (JSON)

Source: https://paranoidlab.com/v1/docs/index

Initiates the verification process for a domain target. This requires sending a JSON payload with the target's ID. Successful verification confirms the presence of a specific DNS TXT record.

```json
{
  "id": 0
}
```

--------------------------------

### PUT /v1/targets/update

Source: https://paranoidlab.com/v1/docs/index

Updates the tag parameter for an existing target.

```APIDOC
## PUT /v1/targets/update

### Description
This endpoint updates the tag parameter for an existing target.

### Method
PUT

### Endpoint
/v1/targets/update

### Request Body
- **id** (integer) - Required - The unique identifier of the target to update.
- **tag** (string) - Required - The new tag for the target. Minimum 3 characters. Default: "default".

### Responses
(No specific success or error response details provided in the source text for this endpoint, but it is expected to return a success status on successful update and appropriate error codes otherwise, e.g., 400, 401, 404, 422.)
```

--------------------------------

### POST /v1/search

Source: https://paranoidlab.com/v1/docs/index

Performs a search for data leaks associated with a specified domain or email.

```APIDOC
## POST /v1/search

### Description
Performs a search for data leaks (e.g., passwords, cookies, PII) associated with a given domain or email address. It aggregates results from various sources like malware and combo lists.

### Method
POST

### Endpoint
/v1/search

### Parameters
#### Request Body
- **query** (string) - Required - The domain name or email address to search for leaks.

### Request Example
```json
{
  "query": "example.com"
}
```

### Response
#### Success Response (200)
- **query** (string) - The search query used.
- **type** (string) - The type of query (e.g., 'email', 'domain').
- **data** (object) - An object containing leak details categorized by source and data type.
  - **malware** (object) - Leak data from malware sources.
    - **password** (object) - Password leak details.
      - **count** (integer) - Number of password leaks found.
      - **last** (string) - Date of the last password leak (YYYY-MM-DD).
    - **cookie** (object) - Cookie leak details.
      - **count** (integer) - Number of cookie leaks found.
      - **last** (string) - Date of the last cookie leak (YYYY-MM-DD).
    - **pii** (object) - Personally Identifiable Information leak details.
      - **count** (integer) - Number of PII leaks found.
      - **last** (string) - Date of the last PII leak (YYYY-MM-DD).
  - **combo** (object) - Leak data from combo lists.
    - **password** (object) - Password leak details.
      - **count** (integer) - Number of password leaks found.
      - **last** (string) - Date of the last password leak (YYYY-MM-DD).
    - **pii** (object) - Personally Identifiable Information leak details.
      - **count** (integer) - Number of PII leaks found.
      - **last** (string) - Date of the last PII leak (YYYY-MM-DD).

#### Response Example
```json
{
  "query": "example.com",
  "type": "domain",
  "data": {
    "malware": {
      "password": {
        "count": 15,
        "last": "2023-05-10"
      },
      "cookie": {
        "count": 5,
        "last": "2023-04-20"
      },
      "pii": {
        "count": 2,
        "last": "2023-03-15"
      }
    },
    "combo": {
      "password": {
        "count": 30,
        "last": "2023-06-01"
      },
      "pii": {
        "count": 8,
        "last": "2023-05-25"
      }
    }
  }
}
```

#### Error Response (422)
Unprocessable Entity
```

--------------------------------

### POST /v1/targets/update-tag

Source: https://paranoidlab.com/v1/docs/index

Updates the tag associated with a specific target. This is useful for organizing and categorizing your targets within the system.

```APIDOC
## POST /v1/targets/update-tag

### Description
Updates the tag associated with a specific target. This is useful for organizing and categorizing your targets within the system.

### Method
POST

### Endpoint
/v1/targets/update-tag

### Parameters
#### Request Body
- **id** (integer) - Required - Target ID for updating the tag.
- **tag** (string) - Required - The new tag to assign to the target.

### Request Example
```json
{
  "id": 0,
  "tag": "default"
}
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **401** Unauthorized
- **404** Not Found
- **422** Unprocessable Entity

#### Response Example (Error)
```json
{
  "detail": "error"
}
```
```

--------------------------------

### DELETE /v1/targets/{id}

Source: https://paranoidlab.com/v1/docs/index

Deletes a specified target and all associated data. This action is irreversible and removes all related information from the system.

```APIDOC
## DELETE /v1/targets/{id}

### Description
This endpoint deletes a specified target and all associated data. Once the target is deleted, any related information, such as verification status and historical records, will also be removed from the system.

### Method
DELETE

### Endpoint
/v1/targets/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Target ID to delete.

### Response
#### Success Response (200)
OK

#### Error Responses
- **401** Unauthorized
- **404** Not Found

#### Response Example (Error)
```json
{
  "detail": "error"
}
```
```

--------------------------------

### List Leaks Response (JSON)

Source: https://paranoidlab.com/v1/docs/index

Provides a list of data breaches or exposures associated with targets. The response includes an array of leak items, each detailing the target, leak type, source, and relevant data.

```json
{
  "items": [
    {
      "id": 0,
      "request_id": 0,
      "target": "string",
      "target_tag": "string",
      "target_type": "email",
      "type": "password",
      "source": "malware",
      "data": {
        "url": "",
        "user": "",
        "password": "",
        "cookie": [ ]
      },
      "created_at": "2019-08-24T14:15:22Z",
      "uploaded_at": "2019-08-24T14:15:22Z",
      "risk": {
        "level": "low",
        "score": 0
      },
      "date": "2019-08-24",
      "device": {
        "ip": "",
        "os": "",
        "user": "",
        "country": "",
        "location": "",
        "zip": "",
        "comp_name": "",
        "malware_path": "",
        "antiviruses": [ ]
      }
    }
  ],
  "count": 0
}
```

--------------------------------

### Delete Target Response (JSON)

Source: https://paranoidlab.com/v1/docs/index

Represents the response after attempting to delete a target. If an error occurs during deletion, a JSON object with an error detail is returned.

```json
{
  "detail": "error"
}
```

--------------------------------

### Update Target Tag (JSON)

Source: https://paranoidlab.com/v1/docs/index

Updates the tag associated with a specific target. This endpoint accepts a JSON payload containing the target's ID and the new tag. It is used to categorize or group targets within the system.

```json
{
  "id": 0,
  "tag": "default"
}
```
Tokens:
Raw