top of page
Introduction
Getting Started
Endpoints
Examples

Vepp API

Introduction

Welcome to the Vepp Developer API Documentation. This guide provides comprehensive information on integrating and utilizing Vepp's APIs to enhance your applications with data verification, enrichment, and editing capabilities.

You can interact with the Vepp API through HTTP requests from any programming language that supports HTTP and JSON. This allows you the flexibility to integrate Vepp's powerful verification functionalities into your preferred language and environment.

This guide will walk you through the process of authentication, available endpoints, request examples, response formats, error handling, rate limiting, and more. By leveraging the Vepp API, you can ensure the authenticity of users and combat fraud effectively.

Getting Started

To get started with the Vepp API, follow the steps below:

  1. Contact Sales: Discuss your integration requirements with our sales department. Once the details are finalized, you will receive a unique API key to access the Vepp API. Ensure the safety of this key as it's essential for accessing Vepp API functionalities.
     

  2. Authenticate Your Requests: Every API call requires authentication. Use the provided API key in the Authorization header of each request to validate your access.
     

  3. Begin Integration: Dive into the integration process by adhering to the documentation and guidelines provided in this guide.

Using the API Key

For all Vepp API requests, include your API Key. Add it in the header using 'X-API-Key' as the key and your actual API Key as the value.

Base URL

All API requests should be made to:

https://vepp-api.vercel.app

Company Enrichment

Endpoint: /company-enrich

Method: POST

Description:

Given a company name, the Company Enrichment functionality verifies its existence by cross-referencing multiple trusted databases. Once verified, it retrieves and provides enriched data about the specified company, offering insights into its background, affiliations, and other pertinent details.

Request Payload:

  • companyName: The name of the company to be enriched.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • companyName: The enriched company name.

  • isRealCompany: Boolean indicating if the company is real.

  • parentCompany: The parent company, if any.

  • agencyOrAdvertiser: Specifies whether the company functions as an "Ad Agency" or an "Advertiser".

  • size: Represents the classification of the company's size, with possible values being "Long Tail", "Large", "Mid", "Small", or "Tail".

  • respondentId (optional): The provided ID of the respondent.

Company Authenticity Check

Endpoint: /company-authenticity-check

Method: POST

Description:

When confronted with lesser-known corporate entities, the Company Authenticity Check harnesses the prowess of Vepp's Company Authenticity Check service. This sophisticated tool ingests specific company parameters, critically analyzing their plausibility and likely existence. Leveraging an extensive compilation of databases, sectorial standards, proprietary data, and in-house algorithms, Company Authenticity Check pinpoints the authenticity of the supplied company information. Whether assessing potential subsidiaries, startups, or companies in niche markets, depend on this service to deliver a comprehensive assessment of the company's legitimacy, enhancing your confidence and reliability in making data-driven decisions.

Request Payload:

  • companyDetails: An object containing detailed attributes about the company that require verification.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • isValidCompany: Boolean denoting the company's validity based on the Company Authenticity Check's assessment.

  • respondentId (optional): The provided ID of the respondent.

Question-Answer Relevance

Endpoint: /question-answer-relevance

Method: POST

Description:

The Question-Answer Relevance functionality assesses the provided answer's appropriateness and relevance to a given question. By leveraging advanced algorithms and contextual analysis, it determines how well the answer aligns with the expected response for the specified question, and ensures that the response is contextually relevant.

Request Payload:

  • question: The posed query or topic for which an answer is expected.

  • answer: The provided response or explanation to the posed question.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • question: The posed query or topic for which an answer is expected.

  • answer: The provided response or explanation to the posed question.

  • IsAnswerRelevant: A boolean value indicating the relevance of the provided answer to the question. A value of True suggests that the answer is deemed relevant to the question, while False would indicate irrelevance.

  • respondentId (optional): The provided ID of the respondent.

Personally Identifiable Information Purifier

Endpoint: /pii-removal

Method: POST

Description:

Utilizing advanced data protection algorithms, the PII Removal endpoint scrubs the input text of any personally identifiable information, ensuring data privacy. This functionality not only removes sensitive data but also identifies the types of PII present, providing a comprehensive overview of the data sanitization process.

Request Payload:

  • text: The text containing potential PII.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • text: The cleaned text with PII removed.

  • PIICleaned: Boolean indicating if any PII was detected and cleaned.

  • PIITypesDetected: List of types of PII detected in the text.

  • respondentId (optional): The provided ID of the respondent.

Grammar and Spelling Corrector

Endpoint: /grammar-spelling-check

Method: POST

Description:

Harnessing the power of linguistic analysis and natural language processing, the Spell Check and Grammar endpoint meticulously examines the provided text for any orthographic or syntactic discrepancies. By comparing against established language standards, it offers precise corrections, ensuring the text's clarity and coherence.

Request Payload:

  • text: The text to be checked for spelling and grammar errors.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • text: The corrected text.

  • correctionsMade: Boolean indicating if any corrections were made.

  • correctionType: List of types of corrections made (e.g., spelling, grammar).

  • respondentId (optional): The provided ID of the respondent.

Profanity Detector

Endpoint: /profanity-check

Method: POST

Description:

In a bid to maintain content decorum and professionalism, the Profanity Check endpoint delves into the input text, searching for any inappropriate or offensive language. Leveraging a comprehensive lexicon of profane terms, this service not only purges the text of any unsavory content but also lists the detected profane words, ensuring transparency in content moderation.

Request Payload:

  • text: The text to be checked for profanity.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • text: The cleaned text with profanity removed.

  • profanityCleaned: Boolean indicating if any profanity was detected and cleaned.

  • profanityWords: List of profane words detected in the text.

  • respondentId (optional): The provided ID of the respondent.

People Social Presence

Endpoint: /search-social-profiles

Method: POST

Description:

The Search Social Profiles endpoint allows you to search for social media profiles associated with a provided full name. It can be a valuable tool for verifying and cross-referencing an individual's online presence.

Request Payload:

  • fullName: The full name of the individual for whom you want to search social profiles.

  • respondentId (optional): The ID of the respondent, for your convenience. (Vepp does not store this data).

Response:​

  • profiles: List of social profiles that match the provided individual.

  • foundProfiles: Boolean indicating whether any social profiles were found.

  • respondentId (optional): The provided ID of the respondent.

Employer Verification OAuth-style redirect

Why Employer Verification is Crucial for B2B Market Research

In the intricate world of B2B market research, the authenticity of data stands as its backbone. Vepp's emphasis on real-time respondent profile verification underscores this importance. By ensuring that respondents genuinely represent the organizations they claim, you not only safeguard the integrity of your research but also elevate its value. This becomes indispensable when your research targets a diverse professional audience, from content creators to high-ranking executives.

Harnessing Corporate Emails for Verification

Vepp's primary mechanism for employer verification is the corporate email. When respondents claim affiliation with a specific employer on Vepp's platform, they are prompted to provide their corporate email. This isn't just a mere data point; it's a gateway to authenticity. Vepp cross-references this email against a comprehensive database of recognized corporate domains and then dispatches a verification email.

This dual-layered approach ensures both the legitimacy of the domain and the respondent's access to it.

Data Flow Overview

  • User Input on Vepp's Platform: The respondent enters their corporate email on Vepp's platform for verification.

  • Email Verification by Vepp: Vepp sends a verification email to the provided corporate address. The respondent clicks on the verification link within this email.

  • Redirect Back: After successful verification, Vepp redirects the respondent back to the initial platform or survey.

Technical Implementation Guide

Constructing the Redirect URL

The foundation of this integration lies in the Redirect URL, which will guide your respondents to Vepp's platform for verification.

  • URL Structure:
     

    https://vepp.vercel.app/?externalIdentifier={RESPONDENT_UNIQUE_IDENTIFIER}&redirectLink={YOUR_LANDING_URL}
     

    • {RESPONDENT_UNIQUE_IDENTIFIER}: A unique identifier for each respondent, ensuring distinct tracking.

    • {YOUR_LANDING_URL}: The endpoint where your respondent will be directed post-verification.
       

Initiating the Verification Process

Direct your respondents to Vepp's platform using the constructed URL. Vepp will handle the intricacies of the verification process.
 

Handling the Post-Verification Redirect

Once Vepp completes the verification, respondents will be redirected back to your specified landing URL. Ensure you have mechanisms in place to capture and process the verification status.

  • URL Structure:

    {YOUR_LANDING_URL}/?externalIdentifier={RESPONDENT_UNIQUE_IDENTIFIER}&company={RESPONDENT_COMPANY}&verified={IS_VERIFIED_BOOLEAN}
     

    • {RESPONDENT_COMPANY}: The respondent's company.

    • {IS_VERIFIED_BOOLEAN}: Boolean indicating if the respondent passed the verification.

Key Considerations

  • Security: Prioritize security by ensuring all URLs use HTTPS. This ensures data integrity and protects against potential threats.

  • User Experience: Ensure a smooth and intuitive experience for respondents. Clearly communicate the verification process and manage expectations regarding redirects and outcomes.
     

By methodically integrating the Employer Verification OAuth-style redirect, you enhance the authenticity and reliability of your B2B market research data.

Privacy and Security Policies

At Vepp, we take your privacy very seriously. We understand the importance of protecting your data and have taken all necessary measures to ensure the safety of your information. We are committed to protecting your privacy and data and have created a comprehensive Privacy Policy to explain how we collect, store, and use data. For more detailed information, please visit vepp.app/privacy.

FAQ

Q: How do I obtain an API key for accessing the Vepp API?

A: To obtain an API key for accessing the Vepp API, please reach out to our sales department. Once your integration requirements are finalized, they will provide you with a unique API key.

Q: What authentication method does the Vepp API use?

A: The Vepp API uses API key-based authentication. All API requests must include the API key in the Authorization header.

Q: What rate limiting policies are implemented for the Vepp API?

A: The Vepp API has rate limiting in place to ensure fair usage and system stability. Each API key has a limit on the number of requests that can be made within a specific time window. If the rate limit is exceeded, a 429 Too Many Requests response will be returned.

Q: Which programming languages are supported for integrating with the Vepp API?

A: The Vepp API is language-agnostic and can be integrated into applications developed in any programming language that supports HTTP requests and JSON parsing. Examples include Python, JavaScript, Java, Ruby, and more.

Q: How can I handle errors returned by the Vepp API?

A: In case of errors, the Vepp API will return appropriate HTTP status codes along with error messages in the response body.

Support

For further support or inquiries regarding the Vepp API, please reach out to our support team at support@xperiti.com.

Privacy
FAQ
Support
bottom of page