Checkins API
The Checkins API allows you to create, retrieve, and manage automated airline check-in requests.
Endpoints
/v1/checkinsCreate a check-in request
Submit a check-in request with passengers and flights for automated processing.
/v1/checkinsList check-in requests
Retrieve a list of your check-in requests with optional filtering.
/v1/checkin/{id}Get a check-in
Retrieve details of a specific check-in request. Note: singular /checkin endpoint.
/v1/checkin/{id}Update a check-in
Update passengers, flights, or seat strategies on a pending check-in. Also resolves a requested_extra_info request by supplying the missing fields.
/v1/checkin/{id}/abortAbort a check-in
Cancel a pending check-in. The record remains with status aborted; nothing is deleted.
/v1/checkins/abort_remoteAbort check-ins by remote ID
Cancel every pending check-in that matches your remote_id (your own booking reference).
/v1/checkin/{id}Delete a check-in (sandbox only)
Sandbox only. Stops processing and removes the sandbox record for test-data cleanup. The production API has no DELETE; use abort to cancel processing.
Create Check-in
Create a check-in request containing passengers and flight segments. At least one passenger and one flight are required.
Each passenger must be identified either by remote_id or by both first_name and last_name.
Each flight requires booking_ref, flight_num, marketing_carrier_code, operating_carrier_code, departure_code and destination_code, plus a complete departure pair: either departure_date with departure_time (local), or departure_date_utc with departure_time_utc. At least one pair must be complete, and every departure value you send must be well-formed, including one belonging to a pair you did not complete. Sending both complete pairs is allowed. If your source data is already in UTC, send the UTC pair directly rather than converting.
seatStrategies may be set at the request level, where it is the booking-wide default, and on an individual flight, where it replaces that default for that flight only.
Request Body
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
remote_id | string | No | Your unique identifier for this booking (for tracking and reference) |
sub_account | string | No | Sub-account identifier for multi-tenant setups |
passengers | array | Yes | Array of passenger objects (see below) |
flights | array | Yes | Array of flight objects (see below) |
seatStrategies | array | No | Array of seat preference strategy strings (see Seat Strategies below) |
Passenger Object
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
first_name | string | No | Passenger first name (as on ticket). Required together with last_name unless you identify the passenger by remote_id. |
last_name | string | No | Passenger last name (as on ticket). Required together with first_name unless you identify the passenger by remote_id. |
remote_id | string | No | Your unique identifier for this passenger. Either this, or both first_name and last_name, must be present. |
gender | string | No | "male" or "female" |
age_class | string | No | "adult", "child", or "infant" |
date_of_birth | string | No | Date of birth in YYYY-MM-DD format (required by some airlines) |
citizenship | string | No | ISO 3166-1 alpha-2 country code (e.g., "US", "GB") |
residence | string | No | Country of residence, ISO 3166-1 alpha-2 code |
email | string | No | Passenger email address |
eticket | string | No | Electronic ticket number |
seat | string | No | Specific seat assignment (e.g., "14A") |
passport_number | string | No | Passport number (for international flights) |
passport_country_of_issue | string | No | Passport issuing country, ISO 3166-1 alpha-2 code |
passport_issue_date | string | No | Passport issue date in YYYY-MM-DD format |
passport_expiry_date | string | No | Passport expiry date in YYYY-MM-DD format |
visa_number | string | No | Visa number |
visa_country_of_issue | string | No | Visa issuing country, ISO 3166-1 alpha-2 code |
visa_issue_date | string | No | Visa issue date in YYYY-MM-DD format |
visa_expiry_date | string | No | Visa expiry date in YYYY-MM-DD format |
ffn | string | No | Frequent flyer number |
ffn_airline | string | No | Frequent flyer airline code (e.g., "BA") |
Flight Object
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
booking_ref | string | Yes | Airline booking reference / PNR (e.g., "ABC123") |
marketing_carrier_code | string | Yes | IATA code of the marketing airline (e.g., "BA", "UA") |
operating_carrier_code | string | Yes | IATA code of the operating airline. For codeshare flights, check-in is attempted on both airlines. |
flight_num | string | Yes | Flight number without airline prefix (e.g., "178") |
departure_date | string | No | Local departure date, YYYY-MM-DD. Required together with departure_time unless you send the UTC pair instead. |
departure_time | string | No | Local departure time at the departure airport, HH:MM. Required together with departure_date unless you send the UTC pair instead. |
departure_date_utc | string | No | UTC departure date, YYYY-MM-DD. Use with departure_time_utc instead of the local pair. Send this directly if your source data is already UTC. |
departure_time_utc | string | No | UTC departure time, HH:MM. Required together with departure_date_utc. |
departure_code | string | Yes | Departure airport IATA code (e.g., "LHR") |
destination_code | string | Yes | Destination airport IATA code (e.g., "JFK") |
seatStrategies | array | No | Seat strategies for THIS flight. When present it replaces the request-level seatStrategies for this flight only; when absent the request-level value applies. |
At least one complete departure pair is required per flight: either departure_date with departure_time, or departure_date_utc with departure_time_utc. Both pairs may be sent. Every departure value supplied is validated, so a malformed value is rejected even if it belongs to a pair you left incomplete.
Seat Strategies
The seatStrategies field accepts an array of strategy strings. Which strategies apply depends on the number of passengers being seated for that flight, which is not always the number you sent: infants may be excluded depending on your account settings. Send skip (any casing) to disable seat selection entirely. The full registered set:
| Strategy | Passengers |
|---|---|
one_psg_window | 1 |
one_psg_aisle | 1 |
one_psg_middle | 1 |
two_psg_two_together_window | 2 |
two_psg_two_together_aisle | 2 |
two_psg_three_seats_block | 2 |
two_psg_two_together | 2 |
two_middle_aisle | 2 |
two_psg_aisle | 2 |
two_psg_two_separately_window | 2 |
two_psg_two_separately_aisle | 2 |
two_psg_two_separately_middle | 2 |
three_psg_three_psg_together_window | 3 |
three_psg_two_rows_window | 3 |
three_psg_three_together | 3 |
three_middle_block | 3 |
three_middle_aisle | 3 |
three_psg_two_rows_aisle | 3 |
three_psg_three_separately_window | 3 |
three_psg_three_separately_aisle | 3 |
three_psg_three_separately_middle | 3 |
four_psg_together_window | 4 |
four_psg_three_block_one_behind | 4 |
four_psg_middle_block | 4 |
four_psg_together | 4 |
four_psg_two_and_two | 4 |
four_psg_four_separately_window | 4 |
four_psg_four_separately_aisle | 4 |
four_psg_four_separately_middle | 4 |
split_on_groups | 4+ |
find_any_seat | Any |
Example Request
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": "BOOKING-12345",
"passengers": [{
"first_name": "John",
"last_name": "Smith",
"remote_id": "pax_1",
"date_of_birth": "1985-03-15",
"citizenship": "GB"
}, {
"first_name": "Jane",
"last_name": "Smith",
"remote_id": "pax_2",
"date_of_birth": "1987-07-22",
"citizenship": "GB"
}],
"flights": [{
"booking_ref": "ABC123",
"marketing_carrier_code": "BA",
"operating_carrier_code": "BA",
"flight_num": "178",
"departure_date": "2026-01-20",
"departure_time": "10:30",
"departure_code": "LHR",
"destination_code": "JFK"
}],
"seatStrategies": ["two_psg_two_together_window"]
}'Use the Sandbox Playground on your dashboard to test API calls interactively. It takes the production request body documented above, so what you build there transfers directly. It validates the documented required fields rather than the full production rule set, and it simulates airline responses instead of contacting airlines, so treat a sandbox success as a well-formed request rather than a guarantee that production will accept it. Code examples above are templates for your production integration.
Response
The response is wrapped in a booking envelope: a numeric booking_id plus a checkins[] array (one entry per flight segment). Passenger and flight details live under each check-in's data object. Use an individual checkins[].id for GET /checkin/{id}; do not substitute the envelope's booking_id.
{
"booking_id": 980972996354,
"checkins": [{
"id": 504061687271,
"booking_id": 980972996354,
"remote_id": "BOOKING-12345",
"data": {
"remote_id": "BOOKING-12345",
"passengers": [
{"num": 1, "remote_id": "pax_1", "first_name": "John", "last_name": "Smith"},
{"num": 2, "remote_id": "pax_2", "first_name": "Jane", "last_name": "Smith"}
],
"flights": [{
"num": 1,
"booking_ref": "ABC123",
"marketing_carrier_code": "BA",
"operating_carrier_code": "BA",
"flight_num": "178",
"departure_date": "2026-01-20",
"departure_time": "10:30",
"departure_code": "LHR",
"destination_code": "JFK"
}],
"seatStrategies": ["one_psg_window"]
},
"files": [],
"status": "idle",
"fail_reason": null,
"scheduled_checkin_time": "2026-01-19T10:30:00+00:00",
"finished_time": null
}]
}After a successful check-in, files[] populates with one entry per passenger pointing at a presigned URL for the boarding pass PDF. Use the exact returned absolute URL, including its query string, without your API key. Its host can differ from the API host; do not prepend the API base URL or construct a production URL from a sandbox file path. See the First Check-in guide for the full lifecycle.
Testing with the Z0 test airline
Use marketing_carrier_code: "Z0" and operating_carrier_code: "Z0" to exercise the sandbox without hitting a real airline. The check-in is scheduled by the backend for scheduled_checkin_time, which is approximately T-24h before departure_date/departure_time. Until that moment, status stays idle; once the simulator processes it, the result depends on flight_num:
100: success with boarding pass101: success, no boarding pass downloadable200: input data error201: more info required (see below)300: temporary error400: airline website error500: internal error
Flight number 201 simulates the production more info required flow: at scheduled_checkin_time the check-in moves to requested_extra_info instead of a terminal status, the request array lists the missing fields as JSON paths (["passengers.0.eticket"]), and a webhook fires: to the check-in's own webhook_url if it has one, otherwise to each sandbox webhook subscribed to checkin.info_requested (the Sandbox API settings webhook is subscribed while push_api_enabled and push_api_request_enabled are both on; see Webhooks). Resolve it with PUT /v1/checkin/{id} supplying the first passenger's eticket; the check-in returns to idle and completes as success within seconds. If you never respond, it fails with fail_reason: 201 after 30 minutes, matching the production no-response timeout.
For immediate test feedback, set departure_date to today or tomorrow; the scheduled time will be within seconds to hours, and pollingGET /checkin/{id} will show the terminal state quickly. A far-future departure_date is also valid but your check-in will remain idle until scheduled_checkin_time arrives.
List Check-ins
Retrieve a paginated list of your check-in requests.
Query Parameters
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter by status: idle, requested_extra_info, success, failed, aborted |
created | string | No | Filter by creation date (YYYY-MM-DD) |
flight_date_from | string | No | Filter flights departing on or after this date (YYYY-MM-DD) |
flight_date_to | string | No | Filter flights departing on or before this date (YYYY-MM-DD) |
limit | integer | No | Number of results per page (default: 500, max: 1000) |
offset | integer | No | Number of results to skip (for pagination, default: 0) |
curl -X GET "https://portal.1checkin.com/api/corp/v1/checkins?status=success&limit=10" \
-H "X-API-KEY: YOUR_PRODUCTION_API_KEY"Get Check-in
Retrieve details of a specific check-in request, including current status and boarding pass information if available. Note the singular /checkin/ endpoint.
curl -X GET "https://portal.1checkin.com/api/corp/v1/checkin/{id}" \
-H "X-API-KEY: YOUR_PRODUCTION_API_KEY"Update Check-in
Update a pending check-in's passengers, flights, or seat strategies via the singular PUT /v1/checkin/{id}. The response is the full check-in object, identical to GET /v1/checkin/{id}.
When a check-in sits in requested_extra_info, the request array names the missing fields as JSON paths (for example "passengers.0.eticket"). Supply them via this endpoint to resume processing; the status returns to idle while the automation continues.
curl -X PUT "https://portal.1checkin.com/api/corp/v1/checkin/{id}" \
-H "X-API-KEY: YOUR_PRODUCTION_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"passengers": [
{"remote_id": "pax_1", "eticket": "0741234567890"}
]
}'Abort Check-in
Cancel a pending check-in. Aborting stops processing; the record remains queryable with status aborted (nothing is deleted). Aborting an already-completed check-in returns 400.
curl -X POST "https://portal.1checkin.com/api/corp/v1/checkin/{id}/abort" \
-H "X-API-KEY: YOUR_PRODUCTION_API_KEY"{"result": "success"}To cancel every check-in created under one of your own booking references, use POST /v1/checkins/abort_remote with the remote_id you supplied at creation:
curl -X POST "https://portal.1checkin.com/api/corp/v1/checkins/abort_remote" \
-H "X-API-KEY: YOUR_PRODUCTION_API_KEY" \
-H "Content-Type: application/json" \
-d '{"remote_id": "your-booking-reference-123"}'Delete Check-in (Sandbox Only)
This endpoint exists only in the sandbox. The production API has no DELETE for check-ins; in production, cancel processing with abort. In the sandbox, DELETE stops processing and removes the record entirely so you can keep test data clean. The response is explicitly marked so integrations never mistake it for a production capability.
curl -X DELETE "https://1checkin.com/api/sandbox/v1/checkin/{id}" \
-H "X-API-KEY: YOUR_SANDBOX_API_KEY"{
"result": "success",
"sandbox_only": true,
"note": "The production API has no DELETE for check-ins. Processing was stopped and the sandbox record was removed. In production, cancel with POST /checkin/{id}/abort."
}Status Values
| Status | Description |
|---|---|
idle | Pending and nonterminal: waiting for its scheduled start or still being processed. scheduled_checkin_time is a planned start, not a completion timestamp; reaching it does not guarantee an immediate terminal result. |
requested_extra_info | The automation needs more data to proceed. The missing fields are listed in the request array as JSON paths (e.g. "passengers.0.eticket"). Resolve with PUT /v1/checkin/{id}; unresolved requests eventually fail with fail_reason: 201. |
success | Check-in succeeded. files[] contains the boarding pass URL(s); fail_reason carries the success code (100 = success with boarding pass, 101 = success without). |
failed | Check-in failed. fail_reason is a numeric result code; retain the exact value, including specific codes such as 420 or 503. See Error handling. It is separate from the HTTP status, and a failed result does not imply an automatic retry. |
aborted | Check-in was aborted before reaching a terminal state (via POST /v1/checkin/{id}/abort or POST /v1/checkins/abort_remote). |
Error Responses
{
"status": "error",
"message_code": "FormError",
"status_code": 422,
"message": "Form error",
"message_human": "Form error",
"data": {
"flights": [{"departure_date": ["Not a valid date."]}]
}
}{
"status": "error",
"message_code": "NotFound",
"status_code": 404,
"message": "Check-in not found",
"message_human": "Not found",
"data": null
}Related
- Passengers API - Manage individual passengers
- Availability API - Check airline support
- Guide: Your First Check-in