# Fluxir Docs

> API documentation for My Platform

## Getting Started

- [Welcome to Fluxir Docs](/getting-started.md): Welcome to the Fluxir documentation. Fluxir offers Compliance‑as‑a‑Service (CaaS) to simplify travel documentation and visa processing.
- [The Trip Flow](/getting-started/the-trip-flow.md): Understand the key concepts and steps involved in the Fluxir trip service workflow.
- [Fluxir Concepts](/getting-started/concepts.md): Learn the foundational concepts used throughout the Fluxir trip flow and service application process.

## API Guides

- [Service Application Flows](/api-guides.md): Fluxir supports two main workflows for handling travel service applications: creating a new trip or updating an existing one. Use the guides below to learn how to manage each flow using the Fluxir API.
- [Creating a New Trip](/api-guides/create-new-trip.md): This tutorial shows you how to create and submit a service application for a new trip in Fluxir. It guides you through the process of creating a new service application in Fluxir.
- [Updating an Existing Trip](/api-guides/update-existing-trip.md): This guide shows you how to resume and update an existing trip and its associated service applications in Fluxir. This is useful for restoring draft applications, editing previously submitted data, or re-processing identity documents.

## Introduction

- [Welcome to the Fluxir API](/api/introduction/.md): The Fluxir API gives you full programmatic access to our travel services platform. Whether you need to manage appointments, process documents, or retrieve visa information, the Fluxir API provides a consistent, secure OAuth2-based interface for all your integration needs.
- [Set Up a Test Environment](/api/environment.md): Learn how to create a test account in Fluxir and use the production API without generating real data.
- [Authentication](/api/authentication.md): How to authenticate with the Fluxir API

### Reference

- [Supported Countries](/api/introduction/reference/supported-countries.md): This page presents a list of supported countries.
- [Travel Application Status](/api/introduction/reference/application-status.md): This page presents a list of possible status a travel service application can be moved to:

## API


### Accounts

- [Retrieves the current tenant billing account.](/api/get-accounts.md): Retrieves the current tenant billing account.

### Appointments

- [Get appointment by service application ID.](/api/get-appointments-by-service-application-id.md): Retrieve the details of an existing appointment by its associated service application ID.

### Attachments

- [Retrieves attachments for the specified owner.](/api/get-attachments-by-owner.md): When ownerType is Visapasses.TravelerAide.Attachments.OwnerType.ServiceApplication, attachments for related visas are also included.
- [Downloads an attachment by identifier.](/api/post-attachments-id-download.md): Performs ownership validation in tenant context before downloading from storage.
- [Deletes an attachment by identifier.](/api/delete-attachment.md): Removes both the stored file and the attachment record.
- [Retrieves attachment types for the specified owner type.](/api/get-attachment-types.md): Retrieves attachment types for the specified owner type.
- [Replaces the file content of an existing attachment.](/api/patch-attachments.md): Replaces the file content of an existing attachment.
- [Creates a new attachment.](/api/post-attachments.md): The attachment is uploaded and linked to the owner specified in input.
- [Creates an attachment for a document item.](/api/post-attachments-document-item.md): Creates an attachment for a document item.
- [Creates an attachment for an identity document.](/api/post-attachments-identity-document.md): Creates an attachment for an identity document.

### Azure Marketplace

- [Resolves a marketplace subscription token.](/api/get-azure-marketplace-resolve.md): Resolves a marketplace subscription token.

### Checkout

- [Retrieves a paged checkout list with Stripe session links and tenant metadata.](/api/get-checkout.md): Retrieves a paged checkout list with Stripe session links and tenant metadata.

### DataVersion

- [Retrieves a data version of a data source by its name.](/api/get-data-version-by-name.md): Returns a default result with an empty stamp when no data version exists for the specified name.
- [Retrieves a data version of a data source available for unauthenticated users by its name.](/api/get-data-version-anonymous.md): Returns a default result with an empty stamp when no data version exists for the specified name.

### DocumentsScheme

- [Retrieves document scheme sections for a visa scheme version.](/api/get-documents-scheme-by-visa-version.md): When normalized is true, item and enum value name identifiers are normalized.

### DocumentTags

- [List document tags.](/api/get-document-tags.md): Retrieve a paged list of document tags with optional text filtering.

### IdentityDocument

- [Create a new identity document for traveler.](/api/post-identity-document-by-traveler-id.md): Create and store a new identity document for the specified traveler.
- [List identity documents by filters.](/api/get-identity-documents.md): Retrieve a paged list of identity documents filtered and sorted by query parameters.
- [Get identity document by ID.](/api/get-identity-document-by-id.md): Retrieve the details of the identity document specified by `id`.
- [Fully update identity document by ID.](/api/put-identity-document-by-id.md): Replace the identity document identified by `id` with a new resource.
- [Partially update identity document by ID.](/api/patch-identity-document-by-id.md): Apply a partial update to the identity document identified by `id`.
- [Delete identity document by ID.](/api/delete-identity-document-by-id.md): Permanently deletes the identity document identified by `id`.

### Invoices

- [Retrieves an invoice by identifier.](/api/get-invoice.md): Retrieves an invoice by identifier.
- [Generates and returns an invoice preview for the specified date period.](/api/get-invoice-for-period.md): Generates and returns an invoice preview for the specified date period.
- [Creates and sends a top-up invoice for the specified amount.](/api/post-invoice-topup.md): Creates and sends a top-up invoice for the specified amount.

### PassportRecognition

- [Extract passport details from uploaded document.](/api/post-passport-recognition.md): Submit a passport image or PDF for OCR processing and return structured passport data.

### PassportType

- [Get all passport types.](/api/get-all-passport-types.md): Retrieve all passport types and optionally filter to published versions only.
- [Get paginated list of passport types.](/api/get-passport-types.md): Retrieve a paged list of passport types with optional filter, sorting, and details.
- [Get passport type by nationality.](/api/get-passport-type-by-nationality.md): Retrieve the passport type that corresponds to the specified nationality country code.
- [Get passport type by document scheme version ID.](/api/get-passport-type-by-version-id.md): Retrieve the passport type associated with the specified document scheme version identifier.
- [Get passport type by ID.](/api/get-passport-type-by-id.md): Retrieve details for a single passport type specified by its unique ID.
- [Get active document scheme version by passport type ID.](/api/get-passport-type-active-version.md): Retrieve the currently active document scheme version for the specified passport type.

### Persons

- [Create a new person.](/api/create-person.md): Create and persist a new person record.
- [Create person from scanned passport.](/api/create-person-from-passport.md): Upload a passport image or PDF for OCR-based creation of a person record.
- [Get person by email address.](/api/get-person-by-email.md): Retrieve the person record associated with the specified email address.
- [Get person by ID.](/api/get-person-by-id.md): Retrieve the details of the person specified by `id`.
- [List persons with filters and pagination.](/api/get-persons.md): Retrieve a paged list of persons with support for filtering, sorting, and pagination.
- [Get multiple persons by a list of IDs.](/api/get-persons-by-id-list.md): Retrieve one or more person records by supplying a list of person IDs.
- [Partially update person by ID.](/api/patch-person-by-id.md): Apply a partial update to the person identified by `id`.
- [Fully update person by ID.](/api/update-person-by-id.md): Replace the person resource identified by `id` with a new object.
- [Delete person by ID.](/api/delete-person-by-id.md): Permanently deletes the person identified by `id`.

### TravelerProfileType

- [Get active traveler profile document scheme version by provider.](/api/get-traveler-profile-type-active-version.md): Retrieve the latest published traveler profile scheme version for a provider.

### TravelServices

- [Create a new travel service application.](/api/create-travel-service-application.md): Submit a new travel service application and return a detailed record of the created application.
- [List travel service applications.](/api/get-travel-service-applications.md): Retrieve a paged list of travel service applications filtered and sorted by query parameters.
- [Get context for travel service application.](/api/get-travel-service-context.md): Retrieve computed traveler context by service application ID or by person, scheme version, and origination.
- [Get travel service intent details by key.](/api/get-travel-service-intent.md): Retrieve the detailed definition of a travel service intent using its unique key.
- [List available travel services.](/api/get-travel-services.md): Retrieve travel services matching the provided filters and trip context.
- [Get multiple travel service applications by list of IDs.](/api/get-travel-services-by-id-list.md): Retrieve multiple travel service applications in a single call.
- [Searches and returns available service intents based on filters and trip context.](/api/post-travel-services-service-intents.md): Rule precedence:
- [Update expected processing time by visa type ID.](/api/update-expected-processing-time-by-visa-type.md): Change expected processing time for a visa type using a non-negative number of days.
- [Update a travel service application by ID.](/api/update-travel-service-application.md): Apply a partial update to the travel service application identified by `id` and return the updated record.
- [Delete a travel service application by ID.](/api/delete-travel-service-application.md): Permanently deletes the service application identified by `id`.
- [Get the available provider names for a travel service type.](/api/get-travel-services-provider-names.md): Returns all registered provider names for the specified serviceType.

### Trip

- [post-api-app-trip](/api/create-trip.md): post-api-app-trip
- [post-api-app-trip-id-finalize-checkout](/api/finalize-trip-checkout.md): post-api-app-trip-id-finalize-checkout
- [get-api-app-trip-id](/api/get-trip.md): get-api-app-trip-id
- [get-api-app-trip-id-checkout](/api/get-trip-checkout.md): get-api-app-trip-id-checkout
- [get-api-app-trip-context](/api/get-trip-context.md): get-api-app-trip-context
- [get-api-app-trip-id-context](/api/get-trip-context-by-id.md): get-api-app-trip-id-context
- [get-api-app-trip](/api/get-trips.md): get-api-app-trip
- [Get Trip by Service Application](/api/get-trips-by-service-application-id.md): Returns the TripDto for the trip that includes the service application identified by {serviceApplicationId}.
- [patch-api-app-trip-id](/api/patch-trip.md): patch-api-app-trip-id
- [put-api-app-trip-id](/api/update-trip.md): put-api-app-trip-id

### TripCountry

- [get-api-app-trip-country](/api/get-paged-trip-countries.md): get-api-app-trip-country
- [get-api-app-trip-country-countries](/api/get-trip-countries.md): get-api-app-trip-country-countries
- [get-api-app-trip-country-by-code](/api/get-trip-country-by-code.md): get-api-app-trip-country-by-code

### VisaForm

- [Get visa form content by service application ID.](/api/get-visa-form-by-service-application-id.md): Retrieve the full content of the visa form for a given travel service application.

### Visas

- [Create a new visa record.](/api/create-visa.md): Create and persist a new visa record, optionally uploading the visa document.
- [Create a new visa history record.](/api/create-visa-history.md): Upload visa details and an optional document to record a historical visa entry.
- [Get list of visa types.](/api/get-visa-types.md): Retrieve a paged list of visa types with optional filtering, sorting, and version details.
- [Get list of visas for a person.](/api/get-visas.md): Retrieve a paged list of visa records for the specified person with filtering and pagination support.
- [Update visa.](/api/update-visa.md): Apply a partial update to the visa record identified by `id`.
- [Update a visa history record.](/api/update-visa-history.md): Apply a partial update to the visa history entry identified by `id`.
- [Delete a visa history record.](/api/delete-visa-history.md): Permanently deletes the visa history entry identified by `id`.

### VisaType

- [Get active visa type version by ID.](/api/get-active-visa-type-version.md): Retrieve the active document scheme version for a visa type.
- [Get all visa types.](/api/get-all-visa-types.md): Retrieve all visa types, optionally filtered by origin or destination.
- [Get visa type details by ID.](/api/get-visa-type-by-id.md): Retrieve the visa type identified by `id`; set `withDetails` to include full metadata.

## Other Pages

- /
- /Homepage/
- /api-guides/
- /api-guides/create-new-trip/
- /api-guides/update-existing-trip/
- /api/accounts/
- /api/appointments/
- /api/attachments/
- /api/authentication/
- /api/azure-marketplace/
- /api/checkout/
- /api/create-person-from-passport/
- /api/create-person/
- /api/create-travel-service-application/
- /api/create-trip/
- /api/create-visa-history/
- /api/create-visa/
- /api/data-version/
- /api/delete-attachment/
- /api/delete-identity-document-by-id/
- /api/delete-person-by-id/
- /api/delete-travel-service-application/
- /api/delete-visa-history/
- /api/document-tags/
- /api/documents-scheme/
- /api/environment/
- /api/finalize-trip-checkout/
- /api/get-accounts/
- /api/get-active-visa-type-version/
- /api/get-all-passport-types/
- /api/get-all-visa-types/
- /api/get-appointments-by-service-application-id/
- /api/get-attachment-types/
- /api/get-attachments-by-owner/
- /api/get-azure-marketplace-resolve/
- /api/get-checkout/
- /api/get-data-version-anonymous/
- /api/get-data-version-by-name/
- /api/get-document-tags/
- /api/get-documents-scheme-by-visa-version/
- /api/get-identity-document-by-id/
- /api/get-identity-documents/
- /api/get-invoice-for-period/
- /api/get-invoice/
- /api/get-paged-trip-countries/
- /api/get-passport-type-active-version/
- /api/get-passport-type-by-id/
- /api/get-passport-type-by-nationality/
- /api/get-passport-type-by-version-id/
- /api/get-passport-types/
- /api/get-person-by-email/
- /api/get-person-by-id/
- /api/get-persons-by-id-list/
- /api/get-persons/
- /api/get-travel-service-applications/
- /api/get-travel-service-context/
- /api/get-travel-service-intent/
- /api/get-travel-services-by-id-list/
- /api/get-travel-services-provider-names/
- /api/get-travel-services/
- /api/get-traveler-profile-type-active-version/
- /api/get-trip-checkout/
- /api/get-trip-context-by-id/
- /api/get-trip-context/
- /api/get-trip-countries/
- /api/get-trip-country-by-code/
- /api/get-trip/
- /api/get-trips-by-service-application-id/
- /api/get-trips/
- /api/get-visa-form-by-service-application-id/
- /api/get-visa-type-by-id/
- /api/get-visa-types/
- /api/get-visas/
- /api/identity-document/
- /api/introduction/reference/application-status/
- /api/introduction/reference/supported-countries/
- /api/invoices/
- /api/passport-recognition/
- /api/passport-type/
- /api/patch-attachments/
- /api/patch-identity-document-by-id/
- /api/patch-person-by-id/
- /api/patch-trip/
- /api/persons/
- /api/post-attachments-document-item/
- /api/post-attachments-id-download/
- /api/post-attachments-identity-document/
- /api/post-attachments/
- /api/post-identity-document-by-traveler-id/
- /api/post-invoice-topup/
- /api/post-passport-recognition/
- /api/post-travel-services-service-intents/
- /api/put-identity-document-by-id/
- /api/travel-services/
- /api/traveler-profile-type/
- /api/trip-country/
- /api/trip/
- /api/update-expected-processing-time-by-visa-type/
- /api/update-person-by-id/
- /api/update-travel-service-application/
- /api/update-trip/
- /api/update-visa-history/
- /api/update-visa/
- /api/visa-form/
- /api/visa-type/
- /api/visas/
- /getting-started/
- /getting-started/concepts/
- /getting-started/the-trip-flow/
- /search/