Loading developer portal
Preparing the API reference and documentation.
Loading developer portal
Preparing the API reference and documentation.
Initiates the passwordless authentication flow by requesting a one-time token for the provided identity. Use this endpoint before token verification to start a secure login session.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Validates the token generated during passwordless login and confirms user authentication. Returns the verification result that can be used to continue protected account flows.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Enables or disables PO Box auto-renewal for an authenticated customer and box reference. Stores the latest auto-renew preference and returns a renewal update outcome.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Processes CRM approval or rejection for a pending agent profile linked to a PO Box. Captures approval remarks and updates downstream status used by renewal/rental journeys.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Handles CRM decisioning for pending rental requests submitted for PO Box services. Applies approval status and remarks so the request can proceed or be rejected.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Confirms payment completion for guest renewal transactions using a payment reference. Finalizes renewal payment status and returns payment details for client follow-up.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Retrieves renewal eligibility, subscription context, and customer data for guest users. Supports renewal, upgrade, and subscription-change scenarios before pricing or save.
int32application/json
application/json
application/json
application/json
Returns available renewed-by options for guest renewal submissions. Use this list to populate UI selections before posting renewal save requests.
application/json
application/json
application/json
application/json
Calculates guest renewal charges based on box details, expiry, bundle changes, and options. Provides a pricing breakdown that should be reviewed before creating payment orders.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Creates or updates guest renewal order details prior to payment confirmation. Persists the renewal payload and returns order-level response data for checkout steps.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Publishes guest renewal notification events for business and customer communication flows. Supports operational messaging and payment history/event propagation.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Fetches issuing entities used for Escher guest trade-license validation journeys. Provides lookup values required in guest corporate renewal and onboarding forms.
application/json
application/json
application/json
application/json
Updates auto-renew preference for guest/Escher scenarios with additional transaction context. Includes last tenure and order references required by guest renewal integration rules.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Retrieves Ministry of Economy entity records using the provided entity code. Used to prefill or validate corporate profile information in rental and renewal flows.
application/json
application/json
application/json
application/json
Looks up MOE entity and owner details using entity code and trade license number. Supports license verification and corporate customer validation workflows.
application/json
application/json
application/json
application/json
Returns the master list of MOE issuing entities. Use this endpoint for dropdowns and validation in corporate license-related forms.
application/json
application/json
application/json
application/json
Cancels a previously created PO Box renewal request by identifier. Typically used after validation/verification steps in the renewal cancellation flow.
int32application/json
application/json
application/json
application/json
Fetches existing renewal agent details associated with the supplied agent identifier. Supports edit and review workflows before update, payment, or deletion operations.
application/json
application/json
application/json
application/json
Processes payment status for renewal agent-related transactions. Uses payment references to reconcile and return final payment execution results.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Processes payment for Tijari (corporate) renewal transactions. Returns payment completion state and details required by post-payment handling.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Creates agent renewal records and optionally prepares payment order information. Accepts agent profile and payment properties to continue the renewal journey.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Saves Tijari corporate renewal data, including company/license details and amounts. Used before corporate payment processing and CRM approval checkpoints.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Updates an existing renewal agent record, including identity and attachment details. Keeps agent information synchronized before approval and payment processing.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Validates whether a PO Box renewal can be cancelled and issues a verification reference. Acts as the first step of the OTP-based cancellation confirmation flow.
int32application/json
application/json
application/json
application/json
Verifies the OTP/reference for cancellation and confirms cancellation authorization. Completes the validation flow before final cancellation actions are executed.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Retrieves additional renewal service details tied to box and emirate context. Used to display optional services and supplementary renewal information.
int32application/json
application/json
application/json
application/json
Confirms payment outcome for a submitted address-change request. Updates payment state using the path payment reference number.
application/json
application/json
application/json
application/json
Confirms payment outcome for a submitted lock-change request. Finalizes lock-change payment status for downstream fulfillment.
application/json
application/json
application/json
application/json
Returns detailed PO Box renewal data for authenticated renewal scenarios. Includes box, subscription, customer, and related context required by renewal UI.
int32application/json
application/json
application/json
application/json
Lists additional optional services available for a selected renewal bundle. Supports add-on selection before pricing and order submission.
application/json
application/json
application/json
application/json
Calculates charges for selected additional renewal service types. Returns total amount and per-service pricing details for transparent billing.
Value in
application/json
application/json
application/json
application/json
Creates an address-change order for a specific PO Box and customer context. Stores delivery/address data and prepares payment metadata when applicable.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Creates a lock-change request and returns order/payment initiation details. Used to start lock replacement workflows before payment confirmation.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Confirms payment for standard PO Box renewal orders. Finalizes renewal transaction status and returns payment/transaction metadata.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Returns the allowed renewed-by values for standard renewal flow. Use this lookup to validate and populate renewal ownership selections.
application/json
application/json
application/json
application/json
Calculates standard renewal pricing based on bundle, dates, and optional changes. Provides detailed service-level pricing and discount-adjusted totals.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Saves standard PO Box renewal payload and creates/updates renewal order data. Returns order references and payment gateway details when payment is needed.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Calculates add-on charges for guest renewal-specific additional service requests. Returns amount breakdowns aligned with guest renewal pricing rules.
Value in
application/json
application/json
application/json
application/json
Returns available rental bundles and package information for PO Box rental journeys. Use this endpoint as the entry point for bundle selection in rental flow.
application/json
application/json
application/json
application/json
Retrieves allowed expiry date options for a selected rental bundle. Supports date pickers and tenure constraints during new rental creation.
application/json
application/json
application/json
application/json
Returns available unassigned PO Boxes filtered by bundle, location, and reseller context. Can also consider hold references when continuing partially completed rentals.
application/json
application/json
application/json
application/json
Fetches eligible PO Box office/location options for the selected bundle and emirate. Used to drive location selection before box reservation.
application/json
application/json
application/json
application/json
Retrieves previously rejected corporate box details for correction/resubmission. Helps clients repopulate and amend rejected rental submissions.
Value in
application/json
application/json
application/json
application/json
Returns renewal details in rental context, including upgrade-only and bundle-change options. Used when transitioning an existing rental into a renewal decision flow.
application/json
application/json
application/json
application/json
Saves complete PO Box rental request data including profiles, services, and payment setup. Creates order context for subsequent payment and confirmation steps.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Selects or reserves a PO Box against bundle and expiry preferences. Used after availability search and before submitting full rental details.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Updates rental payment status using the provided payment reference number. Ensures order state is synchronized after gateway callback/confirmation.
application/json
application/json
application/json
application/json
Submits corrected details for a previously rejected box/corporate rental request. Allows the request to re-enter review and approval processing.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
1 <= length1 <= lengthValue in
1 <= length1 <= lengthint32Value in
1 <= length1 <= length1 <= lengthValue in
Value in
1 <= lengthValue in
1 <= length1 <= lengthdate-timeValue in
int321 <= lengthdate-time1 <= lengthdouble1 <= length1 <= lengthValue in
1 <= length1 <= lengthValue in
1 <= lengthValue in
Value in
1 <= lengthValue in
Value in
int32doubleint321 <= lengthValue in
int32doubleint321 <= lengthint32date-timeint321 <= length1 <= lengthValue in
1 <= length1 <= lengthdoubleValue in
1 <= length1 <= lengthdoubleValue in
1 <= lengthValue in
1 <= length1 <= lengthdate-timeValue in
int321 <= lengthdate-time1 <= lengthdoubleValue in
1 <= lengthdouble1 <= lengthdate-timeValue in
1 <= length1 <= length1 <= length1 <= length1 <= lengthbyte1 <= length1 <= length1 <= length1 <= length1 <= length1 <= length1 <= length