Loading developer portal
Preparing the API reference and documentation.
Loading developer portal
Preparing the API reference and documentation.
Removes the authenticated user's profile and related records from the User Management domain. Use this when a customer requests account closure and data removal from this backend context.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns the currently authenticated user's profile details from the user management store. Includes core identity and contact fields used by account, payments, and shipment flows.
OAuth2 In: header
application/json
application/json
application/json
application/json
Updates customer profile attributes such as names, language, and contact information. Input validation is enforced against the UpdateRequest schema before persisting changes.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Authenticates a user with credentials and issues an application access token response. This endpoint is used by first-party clients to establish an authenticated session context.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Ends the active user session and invalidates login state for the current token context. Clients should call this during sign-out to clear server-side authentication continuity.
OAuth2 In: header
application/json
application/json
application/json
application/json
Exchanges a valid refresh token for a new access token and updated token metadata. Use this to keep users signed in without forcing credential re-entry.
OAuth2 In: header
application/json
application/json
application/json
application/json
Completes login using UAE Pass session data and returns application token information. Used in identity federation scenarios where authentication originates from UAE Pass.
OAuth2 In: header
application/json
application/json
application/json
application/json
Processes UAE Pass callback values (Code, State) to generate application tokens. Supports web and local flow flags for different client execution environments.
OAuth2 In: header
application/json
application/json
application/json
application/json
Updates the user's registered mobile number after identity verification checks. Typically used when UAE Pass and profile phone numbers need to be synchronized.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Validates a passwordless login token bound to a mobile number. Returns success when the token is accepted and can be used for session issuance.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Returns application-level metadata and configuration payload required by clients at startup. Useful for loading environment-aware app capabilities and static app information.
OAuth2 In: header
Fetches static content links and informational resources exposed by the platform. Typically consumed for help links, legal pages, and other app-managed static content.
OAuth2 In: header
application/json
application/json
application/json
application/json
Retrieves invoice data for a payment reference and order type in the PO Box domain. Can return invoice content or file-oriented payload depending on IsFile.
OAuth2 In: header
Value in
application/json
application/json
application/json
application/json
Creates or updates a user's notification channel preferences and consent flags. Controls SMS, email, WhatsApp, and push behavior used by downstream notification flows.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Returns the saved notification preference profile for the authenticated user. Used by clients to prefill communication settings screens.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns notification history records previously sent to the current user. Includes message metadata such as title, body, target type, and timestamps.
OAuth2 In: header
application/json
application/json
application/json
application/json
Fetches the registered push device token for a given mobile number. Used by operational or troubleshooting flows that validate device registration state.
OAuth2 In: header
application/json
application/json
application/json
application/json
Registers or refreshes a mobile device token for push notification delivery. Associates the token with source platform data to support targeted notifications.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Generates and dispatches a one-time password through SMS channels. Supports OTP digit configuration and application code routing.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Generates and sends a one-time password to the specified email destination. Intended for email-based verification and account security workflows.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Triggers an OTP delivery through IVR/call-based channels. Supports language and OTP digit settings for voice verification journeys.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Validates an OTP code against the issued transaction identifier. Returns verification status used to continue secure account or transaction flows.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Stores a new tokenized payment card for the authenticated user's wallet. Supports marking the card as default and saving user-friendly nickname metadata.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Deletes a saved payment card by identifier from the user's card list. Use this when users remove stored cards from their payment preferences.
OAuth2 In: header
int32application/json
application/json
application/json
application/json
Returns all payment cards currently saved for the authenticated user. Includes tokenized card metadata used during checkout and renewals.
OAuth2 In: header
application/json
application/json
application/json
application/json
Fetches invoice details for a specific payment order reference. Used by clients to display or download payment receipts after successful transactions.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns historical payment transactions filtered by optional date range. Covers PO Box and shipment-related charges visible to the current user.
OAuth2 In: header
date-timedate-timeapplication/json
application/json
application/json
application/json
Updates mutable card attributes such as nickname and default card selection. Does not replace tokenized PAN data; it adjusts user wallet preferences.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Confirms a previously initiated PO Box linking request using reference code verification. Finalizes the link so the box becomes available under the user's account context.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Returns PO Boxes linked to the authenticated user including status and relation details. Used to populate ownership/linked box lists in account and shipment scenarios.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns agency-managed PO Boxes filtered by box id, city, and status criteria. Supports operational views for agency users and delegated PO Box management.
OAuth2 In: header
application/json
application/json
application/json
application/json
Provides available status filter values for agency PO Box listing screens. Used by clients to build filter controls consistent with backend status definitions.
OAuth2 In: header
application/json
application/json
application/json
application/json
Looks up PO Boxes using customer identifiers such as mobile and Emirates ID. Supports owner/agent scenarios and request-source aware retrieval behavior.
OAuth2 In: header
Value in
application/json
application/json
application/json
application/json
Removes an existing link between the user and a PO Box using unique box identity. Used when delegated access or linked-box relationships should be revoked.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Validates PO Box and customer details before issuing a link confirmation reference. Acts as the pre-check step prior to ConfirmLinkPoBox.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Checks whether shipment customer actions are available for the given AWB. Returns action availability and explanatory messaging for current shipment state.
OAuth2 In: header
Value in
Value in
application/json
application/json
application/json
application/json
Executes a shipment-level action such as bookmark, alias, or dispute. Persists the selected action against the provided AWB and request source context.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Calculates shipment-related charges and VAT for the selected customer action. Can include address-based recalculations when an updated delivery address is provided.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Confirms payment completion for an address-update request using payment reference number. Returns normalized payment result details for downstream shipment update completion.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns aggregate shipment count based on direction, status, date filters, and PO Boxes. Useful for dashboard badges and summary widgets in shipment management screens.
OAuth2 In: header
Value in
Value in
date-timedate-timeapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Returns detailed shipment information for a single AWB including timeline and options. Used when opening shipment detail pages and action eligibility views.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns a paginated shipment list filtered by AWB, direction, status, dates, and source. Accepts PO Box criteria to scope results to customer-relevant consignments.
OAuth2 In: header
Value in
Value in
date-timedate-timeint32int32Value in
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Retrieves tracking history records for shipments viewed within a date range. Supports client experiences that surface recently tracked or monitored shipments.
OAuth2 In: header
date-timedate-timeValue in
application/json
application/json
application/json
application/json
Submits a delivery address change request for a shipment and selected action. Carries payment and scheduling preferences required to apply address updates.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Updates the destination PO Box details for a shipment identified by AWB. Used when rerouting eligible shipments to a different PO Box number and city.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
1 <= length3 <= length <= 302 <= length <= 1003 <= length <= 302 <= length <= 100^[A-Z]+[a-zA-Z"'\s-]*$0 <= length <= 500 <= length <= 50dateValue in
email1 <= lengthValue in
1 <= length1 <= length1 <= lengthValue in
Value in
Value in
int32int32int32Value in
Value in
int32Value in
1 <= lengthValue in
3 <= lengthValue in
3 <= length3 <= length1 <= lengthValue in
1 <= lengthValue in
Value in
Value in
1 <= lengthValue in
Value in
1 <= lengthValue in
Value in
doubledate-timeValue in
1 <= length1 <= length1 <= length