Zamna Session API is one of 4 APIs that Zamna publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Session. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
9 operations
across 9 paths,
and defines 100 schemas.
It is described by OpenAPI 3.2.0, at version 2.18.
Requests are made against a single base URL, https://paxcheck-app-dev.staging.zamna.com.
The identity and technical contract details declared by the specification.
HaveDocumentQuestion
object
A Yes/No question (boolean), manifested through a positive statement of 'I do have {document type}' format
10 properties
7 required
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
BarcodeToDocMismatch
object
Doc recognition error: Barcode data to document mismatch
1 property
1 required
ErrorContainer
object
1 property
DeparturePoint
object
Departure point - API output
3 properties
3 required
NoBarcodeScannedError
object
Doc recognition error: barcode was not present
1 property
1 required
DocumentSidesExpectation
string
DocumentSidesConfiguration
string
ComposedOr
object
Composed checklist item requirement: Or([ChecklistItemRequirement])
3 properties
3 required
SetAnswersResponse
object
2 properties
ApplyManualDocumentResponseError
object
2 properties
1 required
AddAddressResult
object
1 property
1 required
SetConsentRequest
object
Request to set consent response for MultiPax session
1 property
1 required
PickFromListQuestion
object
A question with options to choose from, requires single answer (option id)
8 properties
5 required
FieldMismatch
object
Rules mismatch: specific document field
2 properties
2 required
QuestionSampleImage
object
Question sample image with a name to form expressions like 'Sample of {title}'
2 properties
1 required
OnwardTicket
object
Manually entered return or onward ticket
2 properties
2 required
ArrivalPoint
object
Arrival point - API output
3 properties
3 required
ComposedAnd
object
Composed checklist item requirement: And([ChecklistItemRequirement])
3 properties
3 required
AllowedDocument
object
Describes a document which can be used to resolve checklist item
13 properties
9 required
AddAddressResponse
object
2 properties
MultipaxSession
object
MultiPax session (ie booking)
3 properties
3 required
DocumentRequirement
object
Document requirement with status and acceptable documents (and methods) to resolve it
13 properties
7 required
SetConsentResponse
object
2 properties
UnknownRecognitionError
object
Doc recognition error: unknown error
2 properties
2 required
PaxSession
object
Pax session (ie passenger)
8 properties
6 required
MrzToVizMismatch
object
Doc recognition error: MRZ to VIZ mismatch
1 property
1 required
ApplyManualDocumentRequest
object
Request to provide manually entered non-travel document data to resolve checklist item(s)
2 properties
2 required
Pax
object
Passenger basic data (first name, last name, birthdate)
3 properties
ApplyRecognisedDocumentResult
object
2 properties
1 required
TravelDocumentRequired
object
Apply file: Passport have to be provided first
1 property
1 required
InfoItem
object
Info item - can't be resolved manually
10 properties
5 required
GeneralError
object
3 properties
1 required
DocumentMrzConfiguration
string
FileTypesNotSupported
object
Doc recognition error: file type not supported
3 properties
3 required
TransitPoint
object
Transit point - API output
4 properties
4 required
MrzVerificationError
object
Doc recognition error: MRZ verification failed
1 property
1 required
FileTooLarge
object
Doc recognition error: file is too large
2 properties
2 required
ApplyManualDocumentResponse
object
2 properties
ApplyTravelDocumentResult
object
2 properties
2 required
GetSessionResponse
object
2 properties
Airport
object
Localised Airport record
3 properties
3 required
ChecklistItemStatus
string
GetPaxSessionResponse
object
2 properties
DeclarationItem
object
A Yes/No question (boolean)
7 properties
5 required
AllowedDocumentsSet
object
A set of documents with which this checklist item can be resolved
2 properties
2 required
SignalsMismatches
object
A record of mismatches to Zamna Signals for document applied
2 properties
2 required
NationalityInMismatch
object
Rules mismatch: nationality
3 properties
3 required
RulesMismatches
object
2 properties
2 required
AddAddressRequest
object
1 property
1 required
IdMismatches
object
A record of mismatches to booking for document applied
8 properties
1 required
AllowedDocumentFormat
string
NotAllSidesScannedError
object
Doc recognition error: not all required document sides were provided
1 property
1 required
RecogniseDocumentResult
object
3 properties
3 required
RecogniseDocumentResponse
object
2 properties
Checklist
object
Comprises checklist statuses, questions/answers and checklist items
10 properties
5 required
NoItemsToApplyDocumentTo
object
Apply file: Found no items in checklist to apply document provided
1 property
1 required
ApplyTravelDocumentResponse
object
2 properties
ApplyRecognisedDocumentResponseError
object
2 properties
DocumentProvisionMethod
string
ApplyRecognisedDocumentResponse
object
2 properties
RecognizedDocumentKindMismatch
object
Doc recognition error: wrong document type
2 properties
2 required
RuleOrigin
object
Origin of the rule
2 properties
2 required
QuestionTitle
object
Question title and optional subtitle
2 properties
1 required
TravelDocument
object
Travel document structure for manual input using /apply-document/travel-document
10 properties
6 required
Check
object
Checklist item requirement: agent check (eg "check: 2 blank pages")
2 properties
2 required
ApplyTravelDocumentRequest
object
Request to provide manually input travel document data to try resolve checklist item(s). When checklistitemid is provided, travel document data applies directl…
2 properties
2 required
RecogniseDocumentResponseError
object
2 properties
Journey
object
Journey record (departure, transit, arrival) - API output
4 properties
3 required
ApplyTravelDocumentResponseError
object
2 properties
1 required
FieldCompare
object
Checklist item requirement: compare field value ({field} {operator} {value}, eg expiryDate = 2025-10-25)
5 properties
5 required
Not
object
Composed checklist item requirement: Not(ChecklistItemRequirement)
3 properties
3 required
ApplyRecognisedDocumentRequest
object
Request to provide scanned or uploaded images/files to resolve checklist item(s)
6 properties
6 required
SetAnswersRequest
object
Request to set nationality, birthdate, answers to questions and confirm/refute declarations
5 properties
NoMrzSideScannedError
object
Doc recognition error: mrz document side wasn't provided
1 property
1 required
FieldIn
object
Checklist item requirement: field value IN list ({field} in [{values}], eg docSubType in [DIPLOMATIC,SERVICE])
4 properties
4 required
Bool
object
Answer to either yes-no-question or have-document-question
3 properties
2 required
FromList
object
Answer to pick-from-list-question
3 properties
3 required
ChecklistResolutionStatus
string
ChecklistItemType
object
Checklist item type, eg RESIDENCEPERMIT/USA which represents USA Green Card
2 properties
1 required
ExpiryDateGteMismatch
object
Rules mismatch: expiry date greater than or equal to
3 properties
3 required
Address
object
7 properties
Option
object
Option to choose for pick-from-list-question
2 properties
2 required
DocumentTypeNotSupported
object
Doc recognition error: file type not supported
1 property
1 required
ApplyManualDocumentResult
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zamna publishes across the network.
