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 verification capabilities. Vepp offers multiple methods of integration, all supporting all six verification layers.

 

The first integration method, ExVepp, is stand-alone and requires no third-party cooperation. In this method verification data is collected in an external Vepp landing page. The second method of integration, InVepp, requires third-party cooperation from any recruiting vendor, survey host, or both. Both methods offer identical verification quality, while InVepp offers a completely frictionless experience for the respondent, with no extra screens. 

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.

Custom Integration: InVepp

Designed for seamless integration into your client survey platform, Vepp empowers you to enhance the survey experience by seamlessly incorporating profile verification and Relevance Check. By leveraging this powerful integration, you can provide your clients with additional layers of data quality assurance and instill trust in the survey results.

Our dedicated team is available to assist you throughout the implementation of this custom integration, ensuring it is tailored to meet your specific requirements. We offer comprehensive documentation, real-life examples, and support to guarantee a smooth integration process.

Contact us today to explore how our custom integration can revolutionize your survey platform.

* Please note that the availability and specific implementation details of custom integration may vary. For further assistance and guidance, please don't hesitate to reach out to our experienced support team.

If you have any questions or need assistance during the process, please reach out to our sales department at sales@xperiti.com.

Endpoints: ExVepp

The Vepp API provides the following endpoints for different verification functionalities:

Respondent Verification

Endpoint: /api/respondent-verification

Description: Verify respondent profiles by conducting real-time checks for authenticity. This endpoint encompasses the following features:

  • Social Network Verification: Authenticate login credentials to verify social data, including follower count and account ownership.

  • Seniority Detection: Verify job titles and seniority against salary data using social HR platforms integration.

  • Engagement Analysis: Analyze social networks to build relationship maps for identity verification and detect potentially fake profiles based on professional public relationships.

  • PPEV™ Transactional Patterns: Deploy pattern recognition software at the point of payment to verify respondent's present and previous employment, ensuring identity verification and combating fraud.

Response Verification

Endpoint: /api/response-verification

Description:

- Plagiarism Detection verify respondents' open-text responses for authenticity and originality. By utilizing this feature, you can ensure the integrity of the data provided by respondents. The Plagiarism Detection functionality scans the respondents' open-text responses and compares them against the open web and public literature. It identifies instances of stolen or copied content, providing you with valuable insights into the originality of the responses. By incorporating the Plagiarism Detection endpoint into your workflow, you can maintain data quality, prevent plagiarism, and ensure that the responses you receive are genuine and unique.

- Company Name Verification: verify company exists by querying public and private databases such as Bloomberg, Dun & Bradstreet and Pitchbook data. 

- Spend Analysis: Benchmark spending patterns against public and proprietary data to provide insights into indicated spend, budgets, and P&L responsibility. Scrape 10-Q SEC filings to determine spend on Sales & Marketing (public companies only). Identify Number of Active Employees to predict advertising spend. 

- Parent Company Identification: leverage Global Family Tree APIs to identify parent company linkage. 

Examples

Verify Respondent Profiles

Endpoint: /api/profile-verification

 

 

 

 

Description:

To verify themselves, the user needs to open the specified URL (/api/profile-verification) with the required parameters.

Use this endpoint to verify respondent profiles by conducting real-time checks for authenticity. Provide the necessary parameters in the request query params:

  • `client_id`: The unique client ID associated with the request.

  • `redirect_url`: The URL to which the verification results will be redirected after the process is completed.

By opening this URL with the provided parameters, the user initiates the verification process and provides essential information for the Vepp API to perform real-time verification checks on the respondent profiles, including:

 

Note: the data below may be collected via ExVepp method from landing page, or via InVepp method by collecting the required data in-survey and sharing with Vepp via API. 

Social Network Verification

Data Needed for Layer: Social Login via SSO (Linkedin, YouTube, Meta, TikTok) - Follower Count, Account Ownership

Seniority Verification

Data Needed for Layer: Current Annual Salary, Name of Employer, Job Title, Location

Engagement Analysis

Data Needed for Layer: Name of Employer, Social Login via SSO (Linkedin, YouTube, Meta, TikTok) - Connections / Friends

Spend Analysis

Data Needed for Layer: Budget / Spend, Name of Employer

PPEV™ transactional patterns

Data Needed for Layer: Full Name, Email, Name of Employer, Job Title

 

Response:

Upon successful verification, the Vepp API will provide the response through the specified `redirect_url` with a JWT token in the query parameter. The token can be decrypted using the `client_secret` to obtain the verification response. Here's an example of the decrypted response:

 

 

Plagiarism Detection

Endpoint: /api/plagiarism-detection

Description:

Utilize the Plagiarism Detection feature to verify respondents' open-text responses for authenticity and originality.

By utilizing this feature, you can ensure the integrity of the data provided by respondents. The Plagiarism Detection functionality scans the respondents' open-text responses and compares them against the open web and public literature. It identifies instances of stolen or copied content, providing you with valuable insights into the originality of the responses.

By incorporating the Plagiarism Detection endpoint into your workflow, you can maintain data quality, prevent plagiarism, and ensure that the responses you receive are genuine and unique.

Response

Upon performing the Plagiarism Detection, the Vepp API will provide a response with the following fields:

  • `plagiarism_status`: This field indicates the status of the plagiarism detection for the given open-text response. It represents whether instances of plagiarism or copied content were found. The possible values could include:

    • "original": Indicates that no instances of plagiarism or copied content were found, suggesting the response is original.

    • "plagiarized": Indicates that portions of the response have been identified as matching or closely resembling existing content from external sources, such as the open web or public literature

  • `plagiarism_probability`: This field represents the probability or confidence level associated with the detected plagiarism. It indicates the likelihood or degree to which the response contains plagiarized content. The value is often expressed as a percentage or a numerical value between 0 and 1, with higher values indicating a higher probability of plagiarism.

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.

Vepp Employment Verification
Privacy
FAQ
Support
bottom of page