Loading developer portal

Preparing the API reference and documentation.

Docs

Guides & Documentation

Overview Quick Start Authentication Changelog

API Operations

All Operations

Account

Request Passwordless TokenPOST Verify Passwordless TokenPOST

POBox

Update Auto Renew ConfigurationPOST

CRM

Approve CRM AgentPOST Approve CRM RentalPOST

GuestRenewal

Confirm Guest Renewal PaymentPOST Guest Renewal DetailsGET Guest Renewed By OptionsGET Calculate Guest Renewal PricingPOST Save Guest Renewal DetailsPOST Send Guest Renewal NotificationPOST Charges For Guest Additional Renewal ServicesGET

Guest

Issuing Entities For Escher GuestGET Update Guest Auto Renew ConfigurationPOST

MOE

MOE Entities By IDGET MOE Entities By License NumberGET MOE Issuing EntitiesGET

Renewal

Cancel PO Box RenewalDELETE Renewal AgentsGET Process Renewal PaymentPOST Process Tijari Renewal PaymentPOST Save Renewal AgentPOST Save Tijari Renewal DetailsPOST Update Renewal AgentPUT Validate Renewal CancellationGET Verify Renewal CancellationPOST Renewal Additional DetailsGET PO Box Renewal DetailsGET Additional Renewal OptionsGET Charges For Additional Renewal ServicesGET Confirm Renewal PaymentPOST Renewed By OptionsGET Calculate PO Box Renewal PricingPOST Save PO Box Renewal DetailsPOST

ChangeAddress

Confirm Address Change PaymentPOST Save Address Change RequestPOST

ChangeLock

Confirm Lock Change PaymentPOST Save Lock Change RequestPOST

Rental

Rental Bundle DetailsGET Rental Expiry DatesGET Available Free BoxesGET PO Box Rental LocationsGET Rejected Box DetailsGET Rental Renewal DetailsGET Save PO Box Rental RequestPOST Select PO Box For RentalPOST Update Rental Payment StatusPOST Update Rejected Box DetailsPOST

Doc Hub

EP.Retail.PoBox.BackEnd.API EndPoints/authentication

Security • EP.Retail.PoBox.BackEnd.API EndPoints

Authenticate EP.Retail.PoBox.BackEnd.API EndPoints requests

Use the authentication model defined in your OpenAPI file, then send credentials with protected API requests.

Security Requirement

Always store client secrets in secure environment variables or key vaults. Never commit credentials to version control.

Authorization Header Format

Include the access token in the standard HTTP Authorization header for all protected requests.

Authorization: Bearer YOUR_API_TOKEN

Security Best Practices

Trusted Systems

Call this API from trusted backend systems only. Do not expose credentials or access tokens in client-side browser bundles.

Operational Support

Log request correlation IDs and timestamps for troubleshooting, keeping authorization headers out of plain-text logs.