Overview of User Provisioning flows, authentication, and airline recognition requirements.
During the user creation process, there are three distinct flows:
- Creation with an Existing Email Domain Associated with IATA CASS:
Upon submission, the API automatically identifies the user's company based on the provided email domain and aligns it with the corresponding office country.
If a match is found, the account is activated automatically.
In case of no match, the account status remains pending, awaiting manual activation.
Our support team intervenes to assist the user in finalizing the activation process. - Creation with a Non-Existing Email Domain Associated with IATA CASS:
When the email domain is not recognized, the API creates the account with the provided company name and country.
The account status remains pending until manual activation is completed.
Our support team contacts the user to facilitate the activation process. - Creation without IATA CASS:
Upon submission, the API places the account in a pending status, awaiting further details.
The user is prompted to provide additional account information either by following a generated link or clicking the link received via email.
Once a user has been created or updated via the User Provisioning API, the FlyWINDOW link is automatically included in future Quote & Book API responses.
User Creation Flow
This endpoint enables the retrieval of an authentication token and a redirection link for accessing the CargoMART portal.
Get Token Flow
This endpoint allows you to add offices to any user already created and associated with your API key.
This endpoint allows you to delete a user associated with the API key by providing their email address as a query parameter. Once deleted, the user will no longer be able to access the APIs tied to the provided API key.
User Provisioning & Airline Recognition
Our API onboarding allows you to use our platform and tools (rate search, schedules, and workflows). However, airline recognition depends on airline-side commercial identification, not API registration alone.
Airlines recognize a forwarder based on commercial credentials already registered in their own systems. This can be achieved through one of the following:
1. IATA CASS (Cargo Accounts Settlement Systems)
Having an IATA CASS number is the primary and most widely accepted way to be recognized as a forwarder by airlines.
Requirements:
- The IATA CASS must be active and already registered in the airline’s system
This enables airlines to:
- Identify you as an authorized forwarder
- Return live rates
- Allow direct eBooking
How to obtain IATA CASS:
- Apply through IATA as an accredited cargo agent
- Once approved, airlines must still have your CASS correctly configured in their systems
Without an airline-side CASS association, rate search and booking will be restricted.
2. Airline Customer ID (Airline-specific)
Some airlines require a customer ID instead of, or in addition to, IATA CASS.
Requirements:
- The customer ID must be provided to us so it can be associated with your account.
Mandatory for rate search with the following airlines:
- American Airlines (AAL)
- Finnair
- Virgin Atlantic Airways
- Lufthansa
- Singapore Airlines
- Qantas Airways
- WestJet
Without the correct customer ID, these airlines will not return rates, even if the API integration is technically correct.
3. Coloader fallback (limited)
When neither IATA CASS nor an airline customer ID is available:
- We may still facilitate rate search via our limited coloader network
- Coverage is market-dependent
- Returned options are not bookable via API
- Booking remains possible via CargoMART (FlyWINDOW)
Summary
- User Provisioning API → enables access to our platform
- IATA CASS or Airline Customer ID → enables airline recognition, live rates, and API booking
- Coloader flow → fallback only, booking via CargoMART