Loading developer portal
Preparing the API reference and documentation.
Loading developer portal
Preparing the API reference and documentation.
Reviews an International Driving License order and records approval outcomes. Supports approve, reject, or reupload decisions per submitted document. Use this endpoint after back-office verification is completed.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Creates a new International Driving License order for the authenticated customer. Accepts personal details, delivery information, uploaded documents, and payment data. Returns a successful order creation response when validation passes.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Retrieves International Driving License orders available to the current user context. Useful for listing submitted requests and tracking their latest processing status. Use order-specific endpoints for detailed record views.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Triggers shipment creation for an eligible International Driving License order. Sends sender and delivery metadata needed by the downstream shipment provider. Call this endpoint after approval and payment are confirmed.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Fetches full details for a single International Driving License order. Includes order-level data used by support and tracking workflows. Provide the order identifier in UUID format.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
uuidGenerates or retrieves invoice details for an International Driving License order. Used to display billing information associated with a completed transaction. Requires the target order identifier in the request path.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Replaces previously rejected or missing IDL documents for an existing order. Supports selective reupload by file type to continue the approval cycle. Use this after a reupload request is issued by operations.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Updates payment state for an International Driving License order. Intended for asynchronous payment callbacks or reconciliation processes. Provide the relevant order or transaction identifier in the request.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
uuidReturns order history across product services based on date and service filters. Supports relative ranges like last 7, 30, 60, or 90 days for quick reporting. Use this endpoint to populate timeline and dashboard views.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
date-timedate-timeValue in
Confirms a Registered SMS order using the provided order reference. Finalizes order state once payment and external checks are complete. Commonly called after the customer returns from the payment flow.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Returns default configuration values required by the Registered SMS client flow. Includes baseline sender and request behavior settings for form initialization. Use this endpoint before composing a new SMS request.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Provides the V2 default values contract for Registered SMS operations. Includes supported languages, character rules, and attachment capabilities. Prefer this version for newer client integrations.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
Deletes one or more Registered SMS records by their identifiers. Use this endpoint for cleanup of drafts or invalid entries. The request body accepts an array of target IDs.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Retrieves Registered SMS history within an optional date interval. Returns message-level entries and aggregate counts for reporting. Useful for account activity screens and operational audits.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
date-timedate-timeapplication/json
application/json
Retrieves a certificate artifact for a previously sent Registered SMS. Supports lookup using message-related query values. Use this endpoint when users request proof of message delivery.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Returns invoice data for a specific Registered SMS transaction. Enables clients to render payment receipts and billing breakdowns. Pass the SMS reference identifier in the route.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Initiates payment for a Registered SMS request. Accepts payment preferences, billing details, and optional saved card data. Use this endpoint before order confirmation.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Sends a new Registered SMS message using provided sender and recipient details. Supports optional certificate delivery, email options, and multilingual content. Returns processing outcome for the message submission.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Retrieves Registered SMS notification and preference settings. Returns all configured preference entries for the active account. Use this endpoint to prefill settings management screens.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
application/json
Creates or updates Registered SMS preference settings. Stores notification email preferences used in message workflows. Submit the full preference payload in the request body.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Marks a specific Registered SMS preference record as default. Ensures subsequent operations use the selected configuration automatically. Provide the target preference ID in the path parameter.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
int32application/json
application/json
Creates a Smart Place order with customer and package information. Accepts optional payment configuration for checkout initialization. Use this endpoint to start a new Smart Place subscription flow.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Retrieves Smart Place orders available to the requester. Intended for listing and tracking Smart Place submissions. Use order-specific routes for full detail or invoice data.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Returns invoice information for a Smart Place order. Useful for billing history and downloadable receipt views. Requires the order identifier as a route parameter.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
Fetches detailed data for a specific Smart Place order. Includes order attributes required for customer support and tracking. Provide the order identifier in UUID format.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
uuidUpdates payment status for a Smart Place transaction. Supports callback and reconciliation flows from payment providers. Use the request identifier provided by the payment process.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
uuidReturns available message tags used by Registered SMS templates. Helps clients compose dynamic messages with supported placeholders. Call this endpoint while building template authoring experiences.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
application/json
Creates a new Registered SMS template with a name and message body. Templates can be reused for faster message composition. Returns success when the template is stored.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Deletes one or more Registered SMS templates. Accepts an array of template UUIDs targeted for removal. Use this endpoint to retire obsolete or duplicate templates.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
uuidapplication/json
application/json
Retrieves paged Registered SMS templates for the current account scope. Supports page number and page size parameters for list navigation. Returns total record count with the requested template slice.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
int32int32application/json
application/json
Updates an existing Registered SMS template. Requires template identifier plus revised name and message content. Use this endpoint for template maintenance workflows.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
Retrieves the current wallet balance for the authenticated user. Used to display available funds before creating paid requests. Returns balance details in the wallet response contract.
Bearer Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the input below.
Example: Bearer ey12abcdef...
In: header
application/json
application/json
1 <= lengthValue in
Value in
Value in
Value in
Value in
1 <= length1 <= lengthuuid1 <= length1 <= items1 <= length1 <= length1 <= length1 <= length1 <= lengthuuid1 <= length1 <= length1 <= length