Zamna Start API

The Start API from Zamna — 1 operation(s) for start.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zamna Start API is one of 4 APIs that Zamna publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Start. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 2.18.

Requests are made against the base URL https://paxcheck-app-dev.staging.zamna.com.

1 operations 1 paths 47 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

2.18

Base URL

https://paxcheck-app-dev.staging.zamna.com

Authentication

HTTP Bearer

Resource Areas

Authentication & Security 1

Zamna Start API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Start 1

GET

/start

Initiate MultiPax session with encrypted booking id, get session token to authorize further requests

5 params → 200

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are AllowedDocument (13 properties), DocumentRequirement (13 properties), HaveDocumentQuestion (10 properties), Checklist (10 properties). Each schema is shown below with its type and property counts.

DocumentProvisionMethod

string

Question

Start1Response

object

2 properties

Operator

string

FieldNotIn

object

Checklist item requirement: field value NOT IN list ({field} not in [{values}], eg docSubType not in [B1,B2,B1/B2])

4 properties 4 required

RuleOrigin

object

Origin of the rule

2 properties 2 required

ChecklistItemType

object

Checklist item type, eg RESIDENCEPERMIT/USA which represents USA Green Card

2 properties 1 required

Journey

object

Journey record (departure, transit, arrival) - API output

4 properties 3 required

ChecklistStatus

string

FieldIn

object

Checklist item requirement: field value IN list ({field} in [{values}], eg docSubType in [DIPLOMATIC,SERVICE])

4 properties 4 required

AllowedDocument

object

Describes a document which can be used to resolve checklist item

13 properties 9 required

PickFromListQuestion

object

A question with options to choose from, requires single answer (option id)

8 properties 5 required

ComposedAnd

object

Composed checklist item requirement: And([ChecklistItemRequirement])

3 properties 3 required

RuleType

string

DocumentRequirement

object

Document requirement with status and acceptable documents (and methods) to resolve it

13 properties 7 required

ChecklistItem

GeneralErrorCode

string

DocumentMrzConfiguration

string

DeclarationItem

object

A Yes/No question (boolean)

7 properties 5 required

Airport

object

Localised Airport record

3 properties 3 required

ArrivalPoint

object

Arrival point - API output

3 properties 3 required

DeparturePoint

object

Departure point - API output

3 properties 3 required

Pax

object

Passenger basic data (first name, last name, birthdate)

3 properties

ChecklistItemStatus

string

ComposedOr

object

Composed checklist item requirement: Or([ChecklistItemRequirement])

3 properties 3 required

Not

object

Composed checklist item requirement: Not(ChecklistItemRequirement)

3 properties 3 required

Option

object

Option to choose for pick-from-list-question

2 properties 2 required

ChecklistResolutionStatus

string

Check

object

Checklist item requirement: agent check (eg "check: 2 blank pages")

2 properties 2 required

QuestionSampleImage

object

Question sample image with a name to form expressions like 'Sample of {title}'

2 properties 1 required

Start1ResponseData

object

Response for /start endpoint

3 properties 2 required

PaxSession

object

Pax session (ie passenger)

8 properties 6 required

DocumentSidesConfiguration

string

AllowedDocumentFormat

string

QuestionTitle

object

Question title and optional subtitle

2 properties 1 required

MultipaxSession

object

MultiPax session (ie booking)

3 properties 3 required

DocumentSidesExpectation

string

GeneralError

object

3 properties 1 required

TransitPoint

object

Transit point - API output

4 properties 4 required

HaveDocumentQuestion

object

A Yes/No question (boolean), manifested through a positive statement of 'I do have {document type}' format

10 properties 7 required

FieldCompare

object

Checklist item requirement: compare field value ({field} {operator} {value}, eg expiryDate = 2025-10-25)

5 properties 5 required

ErrorContainer

object

1 property

AllowedDocumentsSet

object

A set of documents with which this checklist item can be resolved

2 properties 2 required

InfoItem

object

Info item - can't be resolved manually

10 properties 5 required

Checklist

object

Comprises checklist statuses, questions/answers and checklist items

10 properties 5 required

ChecklistItemRequirement

RequiredAction

string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Zamna publishes across the network.

Zamna Session API

AE Profile APIs.io

Zamna Start With Booking Id And Surname API

AE Profile APIs.io

Zamna Start2 API

AE Profile APIs.io

#Start

← Back to Z APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zamna Start API

Metadata

Authentication & Security 1

Paths & Operations 1

Schemas 47

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zamna Start API

Metadata

Authentication & Security 1

Paths & Operations 1

Schemas 47

Specification

Source

More from Zamna 3

API Details

Provider

Explore more