Quick Start

Follow this guide to test the API in the sandbox playground and then integrate with the production API.

Estimated time: 5 minutes

Part 1: Sandbox Testing

The sandbox playground lets you build and test API calls interactively. It uses the documented production request schema, so the request bodies you build here transfer directly to your production integration.

Two differences are worth knowing before you rely on it. The sandbox simulates airline responses rather than contacting airlines: test-airline Z0 flights resolve deterministically to the scenario you select through the flight number, so you get the outcome you asked for, success or a specific failure. That says nothing about whether a real airline would accept a real booking. And its validation covers the documented required fields rather than the full production rule set, so a sandbox success is not a guarantee that production will accept the same request.

Step 1: Create Your Account

for a 1Checkin account if you don't have one yet.

Step 2: Generate a Sandbox Key

Create a sandbox API key from your API Keys dashboard. Sandbox keys start with 1ci_test_.

Step 3: Test in the Sandbox Playground

Open the Sandbox Playground on your dashboard. From there you can:

  • Check route availability for any airline
  • Create check-in requests with passengers and flights
  • Test error scenarios using the Z0 test airline
  • View the exact JSON request/response for every call
Tip: Use airline code Z0 (the test airline) with different flight numbers to simulate different responses: 100 for success with boarding pass, 200 for input error, 201 for the more-info-required flow, 429 for rate limiting, etc.

Part 2: Go Live

Step 4: Complete the Go-Live Checklist

When you're ready to move to production:

  • Accept the terms of service
  • Set up billing (pay-as-you-go or custom plan)
  • Provide your company details
  • Create your Production API Key (under Production Keys)

Part 3: Production Integration

Step 5: Integrate with the Production API

With your Production API Key (the credential shown in /dashboard/keys under Production API Key), use the base URL shown with that key. The examples below use a portal-issued 1ci_live_ key at https://portal.1checkin.com/api/corp/v1. The request format is identical to what you tested in the sandbox playground.

Check route availability
curl
curl -X POST "https://portal.1checkin.com/api/corp/v1/checkAvailable" \
  -H "X-API-KEY: YOUR_PRODUCTION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "airline_code": "BA",
    "departure_code": "LHR",
    "destination_code": "JFK"
  }'
Create a check-in
curl
curl -X POST "https://portal.1checkin.com/api/corp/v1/checkins" \
  -H "X-API-KEY: YOUR_PRODUCTION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "remote_id": "MY-BOOKING-001",
    "passengers": [{
      "first_name": "John",
      "last_name": "Smith",
      "remote_id": "pax_1"
    }],
    "flights": [{
      "booking_ref": "ABC123",
      "departure_code": "LHR",
      "destination_code": "JFK",
      "marketing_carrier_code": "BA",
      "operating_carrier_code": "BA",
      "flight_num": "175",
      "departure_date": "2026-02-15",
      "departure_time": "10:30"
    }],
    "seatStrategies": ["one_psg_window"]
  }'
Check status of a check-in
curl
curl -X GET "https://portal.1checkin.com/api/corp/v1/checkin/{id}" \
  -H "X-API-KEY: YOUR_PRODUCTION_API_KEY"

Understanding Status Values

Check-in requests go through several statuses:

StatusDescription
idleRequest received, waiting for the check-in window to open.
successCheck-in completed; boarding pass available when the airline returns one.
failedCheck-in could not be completed (input, airline, or internal error).
abortedCheck-in was cancelled before the window opened.

See the Checkins API reference for the full status flow and filterable values.

Next Steps

Congratulations! You've learned the full workflow. Here's what to explore next: