API Reference
/
Compliance Monitoring

VwD External API (1.0.0)

External API for accessing VwD creators data.

Download OpenAPI description
index.json
index.yaml
Overview
VwD API Support

support@vwd.ai

License

MIT

Languages
Servers
VwD Production API Server

https://api.vwd.ai/api/public/v1/

Mock server

https://apidocs.vwd.ai/_mock/apis/

Creator Management

Endpoints related to creators information and searches.

Operations

Brand Management

Endpoints for brand search and management.

Operations

List Management

Endpoints for managing creator lists.

Operations

Search

Full-text search endpoints powered by Elasticsearch.

Operations

Content Analysis

Endpoints for retrieving creators posts with labels.

Operations

Brand Mentions

Endpoints for creators posts and timelines related to brands.

Operations

Compliance Monitoring

Endpoints for creators compliance data.

Operations

Retrieve Creators Compliance Timeline

Request

Public API Endpoint

Fetch a timeline of compliance violations for a given creators. The response groups compliance violations by year and month. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
compliance_keystringrequired

Compliance framework or specific violation subcategory to filter by.

Top-level frameworks: FTC, FINRA, Healthcare

FTC subcategories: FTC_PARTNERSHIP, FTC_FALSE_CLAIMS, FTC_FALSE_ADVICE, FTC_COPPA, FTC_PRIVACY

FINRA subcategories: FINRA_FALSE_CLAIMS, FINRA_FALSE_STATEMENTS, FINRA_FALSE_ADVICE, FINRA_COMPARATIVE_STATEMENTS, FINRA_MEMBERSHIP, FINRA_FIGURES

Healthcare subcategories: HEALTHCARE_PERSONAL_INFORMATION, HEALTHCARE_FALSE_INFORMATION, HEALTHCARE_PRODUCT_USE, HEALTHCARE_CLINICAL_INACCURACY, HEALTHCARE_NON_ACCESSIBLE_CONTENT, HEALTHCARE_INFORMATION_LIMITATIONS

Enum"FTC""FINRA""Healthcare""FTC_PARTNERSHIP""FTC_FALSE_CLAIMS""FTC_FALSE_ADVICE""FTC_COPPA""FTC_PRIVACY""FINRA_FALSE_CLAIMS""FINRA_FALSE_STATEMENTS"
curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/creators/{id}/compliance-timeline/?compliance_key=FTC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Timeline of compliance violations grouped by year and month.

Bodyapplication/jsonArray [
yearinteger

Year of the timeline.

Example: 2024
monthsArray of objects

List of months with active status.

]
Response
application/json
[
  {
    "year": 2024,
    "months": [ … ]
  }
]

Retrieve Creators Compliance Posts

Request

Public API Endpoint

Fetch all posts for a given creators with compliance violations. Optional filters for year and month can be applied. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
compliance_keystringrequired

Compliance framework or specific violation subcategory to filter by.

Top-level frameworks: FTC, FINRA, Healthcare

FTC subcategories: FTC_PARTNERSHIP, FTC_FALSE_CLAIMS, FTC_FALSE_ADVICE, FTC_COPPA, FTC_PRIVACY

FINRA subcategories: FINRA_FALSE_CLAIMS, FINRA_FALSE_STATEMENTS, FINRA_FALSE_ADVICE, FINRA_COMPARATIVE_STATEMENTS, FINRA_MEMBERSHIP, FINRA_FIGURES

Healthcare subcategories: HEALTHCARE_PERSONAL_INFORMATION, HEALTHCARE_FALSE_INFORMATION, HEALTHCARE_PRODUCT_USE, HEALTHCARE_CLINICAL_INACCURACY, HEALTHCARE_NON_ACCESSIBLE_CONTENT, HEALTHCARE_INFORMATION_LIMITATIONS

Enum"FTC""FINRA""Healthcare""FTC_PARTNERSHIP""FTC_FALSE_CLAIMS""FTC_FALSE_ADVICE""FTC_COPPA""FTC_PRIVACY""FINRA_FALSE_CLAIMS""FINRA_FALSE_STATEMENTS"
yearinteger

Year filter for posts (optional).

monthinteger

Month filter for posts (optional).

curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/creators/{id}/compliance-posts/?compliance_key=FTC&month=0&year=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of posts with compliance violations.

Bodyapplication/jsonArray [
idinteger

Post ID.

Example: 12345
platform_namestring

Platform name where the post was published.

Example: "Instagram"
datestring

Date of the post.

Example: "January 1, 2024"
linkstring

URL link to the post.

Example: "https://instagram.com/post/12345"
reasonsArray of objects

List of compliance violation reasons associated with the post.

brandsArray of objects

Brands mentioned in the post.

is_dismissedboolean

Whether the post has been dismissed.

Example: false
article_titlestring

Article title (Google News posts only).

image_urlstring

Image URL (Google News posts only).

article_textstring

Article text content (Google News and Reddit posts only).

source_namestring

Source name (Google News posts only).

]
Response
application/json
[
  {
    "id": 12345,
    "platform_name": "Instagram",
    "date": "January 1, 2024",
    "link": "https://instagram.com/post/12345",
    "reasons": [ … ],
    "brands": [ … ],
    "is_dismissed": false,
    "article_title": "string",
    "image_url": "string",
    "article_text": "string",
    "source_name": "string"
  }
]