Overview
Get API access
API
Overview
Get API access
API

Overview

Streamline the visa application process with the sherpa° Requirements API

Introduction

Retrieve a wide range of entry requirements and travel restrictions, including visa, passport and travel documentation requirements. Offer eVisa and eTA purchases as an added service throughout the customer journey. The sherpa° Requirements API makes it easy to keep your customers informed and prepared for their trip, helping them have a smoother and more enjoyable travel experience.

  • Data retrieved from over 2,000 sources, including Government, Travel Organizations & Services and data sharing agreements
  • Data is transmitted over SSL with TLS 1 (Transport Layer Security)
  • Server-side encryption at rest under the 256-bit Advanced Encryption Standard
  • Complies with Open API standard, identified by IATA as the best practice for the airline industry
  • Access to independent sandbox environment for testing available
  • Localized for multiple languages
🚀 Get Started

New to the sherpa° Requirements API? You can be up and running in minutes using our Quickstart Guide.

Authentication

The sherpa° Requirements API uses API key authentication for secure access. All requests must include your API key in the x-api-key header.

Getting API access

  1. Request your API key : Fill out our online form to get started
  2. Provide details: Share your use case, expected volume, and integration timeline
  3. Complete setup: We'll create your account and provide API credentials

API Key Usage

Include your API key in every request header:

Example
curl --location 'https://requirements-api.joinsherpa.com/v3/trips?include=restriction%2Cprocedure' \
--header 'Content-Type: application/vnd.api+json' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--data '{
    "data": {
        "type": "TRIP",
        "attributes": {
            "locale": "en-US",
            "traveller": {
                "passports": ["GBR"]
            },
            "currency": "USD",
            "travelNodes": [
                {
                    "type": "ORIGIN",
                    "airportCode": "LHR",
                    "departure": {
                        "date": "2025-12-07",
                        "time": "12:59",
                        "travelMode": "AIR"
                    }
                },
                {
                    "type": "DESTINATION",
                    "airportCode": "JFK",
                    "arrival": {
                        "date": "2025-12-08",
                        "time": "12:59",
                        "travelMode": "AIR"
                    }
                }
            ]
        }
    }
}'
🔐 Security Best Practices
  • Never expose your API key in client-side code or public repositories - Store API keys securely in environment variables or secret management systems - Rotate your API key regularly for enhanced security

Environments

The sherpa° Requirements API provides two environments to support your development and production needs.

Production Environment

Base URL: https://api.joinsherpa.com

  • Purpose: Live production applications
  • Data: Real-time, up-to-date travel requirements
  • Access: Default enviornment

Sandbox Environment

Base URL: https://api-sandbox.joinsherpa.com

  • Purpose: Development, testing, and integration
  • Data: Sample data for testing scenarios
  • Access: Can be requested through your partner success manager

Postman Collection

Postman Collections

Get started with our comprehensive API collection and examples. Import the main collection to access all endpoints, or choose from specific collections below for targeted testing.

Available Collections

Requirements API

Complete collection for travel requirements and travel documentation.

Rate Limits & Quotas

  • Sandbox: 1000 requests per hour for testing
  • Production: Varies by plan (contact us for details)
  • Headers: Rate limit information included in response headers

Caching

API responses can be cached to improve performance and reduce API calls. The /trips endpoint includes cache-control headers with a value of public, max-age=3600 (1 hour).

Best Practices:

  • Follow the 1-hour cache duration to ensure data freshness
  • Data is updated hourly, so longer caching may result in outdated information
  • Implement cache invalidation strategies for critical travel requirements
  • Consider user-specific caching for personalized travel data

Requirements API Cache