# Xerobi Developer Docs

- [Xerobi Developer Documentation](https://docs.xerobi.com/index.md): Build powerful applications with Xerobi's comprehensive suite of APIs - from payments and messaging to network infrastructure and certification
- [Quickstart Guide](https://docs.xerobi.com/faq-guides/quickstart.md): Get started with Xerobi APIs in minutes
- [Authentication](https://docs.xerobi.com/faq-guides/authentication.md): Secure your API requests with proper authentication
- [API Versioning](https://docs.xerobi.com/faq-guides/versioning.md): Understand how Xerobi handles API versioning and backward compatibility
- [Webhooks](https://docs.xerobi.com/faq-guides/webhooks.md): Set up real-time notifications for your Xerobi integration
- [Error Handling](https://docs.xerobi.com/faq-guides/error-handling.md): Handle API errors gracefully and implement robust error recovery
- [Best Practices](https://docs.xerobi.com/faq-guides/best-practices.md): Follow these guidelines for reliable and maintainable Xerobi integrations
- [Payment API FAQ](https://docs.xerobi.com/faq-guides/payment-api-faq.md): Frequently asked questions about the Xerobi Payment Gateway API
- [SMS API FAQ](https://docs.xerobi.com/faq-guides/sms-api-faq.md): Frequently asked questions about the Xerobi SMS Gateway API
- [Certification API FAQ](https://docs.xerobi.com/faq-guides/certification-api-faq.md): Frequently asked questions about the Xerobi Certification & Badge API
- [Time Synchronization FAQ](https://docs.xerobi.com/faq-guides/time-synchronization.md): Frequently asked questions about NTP and time synchronization services
- [DNS Security FAQ](https://docs.xerobi.com/faq-guides/dns-security.md): Frequently asked questions about DNS security and best practices
- [Content Filtering FAQ](https://docs.xerobi.com/faq-guides/content-filtering.md): Frequently asked questions about DNS-based content filtering and security
- [Xerobi Payment API Introduction](https://docs.xerobi.com/payment-api/introduction.md): Xerobi Payment API - A developer-first REST API for a modern payment gateway
- [Create Payment Intent](https://docs.xerobi.com/payment-api/endpoint/create-payment-intent.md): Create a PaymentIntent to begin the payment flow. Use `Idempotency-Key` header to make this request idempotent.
- [List Payment Intents](https://docs.xerobi.com/payment-api/endpoint/list-payment-intents.md): List PaymentIntents with optional filtering and pagination.
- [Retrieve Payment Intent](https://docs.xerobi.com/payment-api/endpoint/retrieve-payment-intent.md)
- [Attach Payment Method to Payment Intent](https://docs.xerobi.com/payment-api/endpoint/attach-payment-method-to-intent.md): Attach an existing payment method (or ephemeral) to an intent. Idempotent by Idempotency-Key.
- [Confirm Payment Intent](https://docs.xerobi.com/payment-api/endpoint/confirm-payment-intent.md): Confirm the intent to finalize payment. This will attempt authorization/capture depending on capture_method. Use Idempotency-Key to protect retries.
- [Create Payment Method](https://docs.xerobi.com/payment-api/endpoint/create-payment-method.md): Create a vaultable payment method. In production, clients should use a frontend tokenization flow (PCI scope reduction).
- [Retrieve Payment Method](https://docs.xerobi.com/payment-api/endpoint/retrieve-payment-method.md)
- [Create Customer](https://docs.xerobi.com/payment-api/endpoint/create-customer.md)
- [List Customers](https://docs.xerobi.com/payment-api/endpoint/list-customers.md)
- [Retrieve Customer](https://docs.xerobi.com/payment-api/endpoint/retrieve-customer.md)
- [Attach Payment Method to Customer](https://docs.xerobi.com/payment-api/endpoint/attach-payment-method-to-customer.md)
- [Create Refund](https://docs.xerobi.com/payment-api/endpoint/create-refund.md): Issue a full or partial refund for a charge. Use Idempotency-Key to protect retries.
- [Retrieve Refund](https://docs.xerobi.com/payment-api/endpoint/retrieve-refund.md)
- [Create Webhook Endpoint](https://docs.xerobi.com/payment-api/endpoint/create-webhook-endpoint.md): Register a new webhook endpoint to receive delivery status updates.
- [List Webhook Endpoints](https://docs.xerobi.com/payment-api/endpoint/list-webhook-endpoints.md): Retrieve all registered webhooks for your account.
- [List Event Deliveries](https://docs.xerobi.com/payment-api/endpoint/list-event-deliveries.md)
- [Get Request Trace](https://docs.xerobi.com/payment-api/endpoint/get-request-trace.md): Useful for debugging: returns a structured trace (events, webhook pushes, DB ops) for the given X-Request-Id generated by the gateway.
- [Xerobi SMS Gateway API Introduction](https://docs.xerobi.com/sms-api/introduction.md): Xerobi SMS Gateway API - A modern, developer-friendly SMS Gateway API
- [Send SMS](https://docs.xerobi.com/sms-api/endpoint/send-sms.md): Send a single SMS message to one recipient.
- [Send Bulk SMS](https://docs.xerobi.com/sms-api/endpoint/send-bulk-sms.md): Send SMS to multiple recipients in a single API call. Ideal for campaigns and notifications to large audiences.
- [Get bulk job status](https://docs.xerobi.com/sms-api/endpoint/get-bulk-job.md): Retrieve the status and statistics of a bulk messaging job.
- [List messages](https://docs.xerobi.com/sms-api/endpoint/list-messages.md): Retrieve a paginated list of sent messages with optional filters.
- [Get message details](https://docs.xerobi.com/sms-api/endpoint/get-message.md): Retrieve detailed information about a specific message including delivery status and timeline.
- [List Sender IDs](https://docs.xerobi.com/sms-api/endpoint/list-senders.md): Get all sender IDs registered to your account with their approval status.
- [Request Sender ID](https://docs.xerobi.com/sms-api/endpoint/request-sender-id.md): Submit a new sender ID for registration and approval.
- [List Message Templates](https://docs.xerobi.com/sms-api/endpoint/list-templates.md): Retrieve all message templates in your account.
- [Create Message Template](https://docs.xerobi.com/sms-api/endpoint/create-template.md): Create a new message template with variable placeholders.
- [Send using template](https://docs.xerobi.com/sms-api/endpoint/send-template.md): Send SMS using a template with variable substitution.
- [Get Account Balance](https://docs.xerobi.com/sms-api/endpoint/get-balance.md): Retrieve current account balance and credit information.
- [Get usage report](https://docs.xerobi.com/sms-api/endpoint/get-usage-report.md): Retrieve detailed usage statistics and analytics for a specific period.
- [List Webhooks](https://docs.xerobi.com/sms-api/endpoint/list-webhooks.md): Retrieve all registered webhooks for your account.
- [Register Webhook](https://docs.xerobi.com/sms-api/endpoint/register-webhook.md): Register a new webhook endpoint to receive delivery status updates.
- [Get webhook details](https://docs.xerobi.com/sms-api/endpoint/get-webhook.md): Retrieve detailed information about a specific webhook.
- [Update webhook](https://docs.xerobi.com/sms-api/endpoint/update-webhook.md): Update webhook configuration including URL, events, or description.
- [Delete webhook](https://docs.xerobi.com/sms-api/endpoint/delete-webhook.md): Remove a webhook endpoint from your account.
- [Xerobi Certification & Badge API Introduction](https://docs.xerobi.com/certify-api/introduction.md): Xerobi Certification & Badge API - A modern API for issuing and managing digital certificates and badges
- [List Templates](https://docs.xerobi.com/certify-api/endpoint/list-templates.md): Retrieve a list of all certificate templates available in your organization. Templates define the visual design and field structure for certificates.
- [Create Template](https://docs.xerobi.com/certify-api/endpoint/create-template.md): Create a new certificate template with custom background image and field definitions. Templates are reusable designs for issuing certificates.
- [List Credentials](https://docs.xerobi.com/certify-api/endpoint/list-credentials.md): Retrieve a paginated list of all credentials issued by your organization, including certificates and badges. Use this endpoint to track issued credentials and their current status.
- [Issue Credential](https://docs.xerobi.com/certify-api/endpoint/issue-credential.md): Issue a new digital certificate or badge to a recipient. The credential will be generated based on the specified template and recipient information. An email notification will be sent to the recipient with their credential details.
- [Verify Credential](https://docs.xerobi.com/certify-api/endpoint/verify-credential.md): Public endpoint to verify the authenticity and current status of a digital certificate or badge. This endpoint can be used by third parties to validate credentials without authentication.
- [Revoke Credential](https://docs.xerobi.com/certify-api/endpoint/revoke-credential.md): Revoke a previously issued credential, marking it as invalid. This action cannot be undone. The credential will no longer be verifiable and the recipient will be notified if webhooks are configured.
- [List Badges](https://docs.xerobi.com/certify-api/endpoint/list-badges.md): Retrieve a list of all digital badge definitions in your organization. Badges are metadata definitions that can be used when issuing credentials.
- [Create Badge](https://docs.xerobi.com/certify-api/endpoint/create-badge.md): Create a new digital badge definition with metadata including name, image, and earning criteria. Badge definitions are reusable templates for issuing achievement badges.
- [List Programs](https://docs.xerobi.com/certify-api/endpoint/list-programs.md): Retrieve a list of all certification programs in your organization. Programs help organize related credentials and track learning pathways.
- [Create Program](https://docs.xerobi.com/certify-api/endpoint/create-program.md): Create a new certification program to organize related credentials. Programs provide structure for learning pathways and credential hierarchies.
- [Create Webhook](https://docs.xerobi.com/certify-api/endpoint/create-webhook.md): Register a webhook endpoint to receive real-time notifications about credential events such as issuance, revocation, and verification attempts. Webhooks help you stay updated on credential lifecycle changes.
- [List Audit Logs](https://docs.xerobi.com/certify-api/endpoint/list-audit-logs.md): Retrieve a comprehensive audit trail of all credential-related activities in your organization. This includes credential issuance, revocation, verification attempts, and administrative actions for compliance and security purposes.
- [Xerobi Fiber API](https://docs.xerobi.com/network-api/introduction.md): API for Xerobi Fiber customers and business clients
- [Get consumer network info](https://docs.xerobi.com/network-api/endpoint/get-consumer-network.md): Returns current network configuration including IP addresses, plan details, and service status for the authenticated consumer account.
- [Get consumer account info](https://docs.xerobi.com/network-api/endpoint/get-consumer-account.md): Returns account details including billing status, subscription validity, and auto-renewal settings.
- [Get consumer usage stats](https://docs.xerobi.com/network-api/endpoint/get-consumer-usage.md): Returns data usage statistics including daily and monthly consumption. Usage data is updated approximately every 15 minutes.
- [Get speed test configuration](https://docs.xerobi.com/network-api/endpoint/get-speedtest-config.md): Returns configuration for running speed tests against Xerobi's nearest server. The server selection is automatic based on the customer's location.
- [List all business IP assignments](https://docs.xerobi.com/network-api/endpoint/list-business-ip-assignments.md): Returns all IP addresses and ranges assigned to the authenticated business account, including their status and reverse DNS configuration.
- [Get business bandwidth usage](https://docs.xerobi.com/network-api/endpoint/get-business-bandwidth-usage.md): Returns bandwidth usage statistics for the specified time period, including inbound, outbound, and peak usage metrics.
- [RPKI API](https://docs.xerobi.com/rpki-api/introduction.md): Route origin validation and RPKI infrastructure monitoring
- [Check Route Validity (Path)](https://docs.xerobi.com/rpki-api/endpoint/check-validity-path.md): Returns a JSON object describing whether the route announcement given by its origin AS Number and address prefix is RPKI valid, invalid, or not found. A complete list of VRPs that caused the result is included.
- [Check Route Validity (Query)](https://docs.xerobi.com/rpki-api/endpoint/check-validity-query.md): Returns a JSON object describing whether the route announcement is RPKI valid, invalid, or not found. Same as the path-based endpoint but with a more form-friendly calling convention.
- [Validate Multiple Routes](https://docs.xerobi.com/rpki-api/endpoint/validate-routes.md): Returns a JSON object describing the validity of multiple routes. Expects a JSON body with an array of route announcements. The request body size is limited to 100 kB.
- [Get Status](https://docs.xerobi.com/rpki-api/endpoint/get-status.md): Returns exhaustive information in JSON format on all trust anchors, repositories, RRDP and rsync connections, as well as RTR and HTTP sessions. This data set provides the source for the Routinator user interface.
- [Get Service Status](https://docs.xerobi.com/rpki-api/endpoint/get-service-status.md): Returns basic service status information
- [Get Version](https://docs.xerobi.com/rpki-api/endpoint/get-version.md): Returns Routinator version information
- [Get Log](https://docs.xerobi.com/rpki-api/endpoint/get-log.md): Returns logging information from the Routinator service
- [Get Prometheus Metrics](https://docs.xerobi.com/rpki-api/endpoint/get-metrics.md): Returns monitoring metrics in Prometheus format
- [Get JSON Delta](https://docs.xerobi.com/rpki-api/endpoint/get-json-delta.md): Returns a JSON object with the changes since the dataset version identified by the session and serial query parameters. If a delta cannot be produced from that version, the full data set is returned and the 'reset' field will be true.
- [Get Delta Notification](https://docs.xerobi.com/rpki-api/endpoint/get-delta-notify.md): Returns session ID and serial number of the current dataset. If session and serial parameters match the current values, the request will block until a new dataset is available. This provides a long-polling mechanism for update notifications.
- [Xerobi Speed Test API](https://docs.xerobi.com/speed-api/introduction.md): Comprehensive network speed testing API with advanced metrics and real-time monitoring
- [Health Check](https://docs.xerobi.com/speed-api/endpoint/health-check.md): Returns server health status, uptime, memory usage, and total test count.
- [Latency Test](https://docs.xerobi.com/speed-api/endpoint/latency-test.md): Measures network latency (ping) to the test server. This is a single round-trip time measurement.
- [Jitter Test](https://docs.xerobi.com/speed-api/endpoint/jitter-test.md): Measures jitter (latency variance) by performing multiple ping tests and calculating the standard deviation.
- [Latency Variance Test](https://docs.xerobi.com/speed-api/endpoint/latency-variance.md): Measures comprehensive latency statistics by running 20 ping tests and calculating percentiles.
- [Download Speed Test](https://docs.xerobi.com/speed-api/endpoint/download-test.md): Measures download speed using a 10MB test file.
- [Upload Speed Test](https://docs.xerobi.com/speed-api/endpoint/upload-test.md): Measures upload speed using a 1MB test file.
- [Advanced Download Speed Test](https://docs.xerobi.com/speed-api/endpoint/advanced-download.md): Measures download speed using multiple file sizes (1MB, 10MB, 50MB) for more accurate and comprehensive results.
- [Advanced Upload Speed Test](https://docs.xerobi.com/speed-api/endpoint/advanced-upload.md): Measures upload speed using multiple file sizes (1MB, 10MB, 50MB) for comprehensive analysis.
- [Full Speed Test](https://docs.xerobi.com/speed-api/endpoint/full-test.md): Comprehensive speed test measuring all network metrics in a single test.
- [Advanced Speed Test](https://docs.xerobi.com/speed-api/endpoint/advanced-test.md): Most comprehensive speed test with multi-file analysis for maximum accuracy.
- [Custom Speed Test](https://docs.xerobi.com/speed-api/endpoint/custom-test.md): Runs a full speed test against a specific test server.
- [List Test Servers](https://docs.xerobi.com/speed-api/endpoint/list-servers.md): Returns all available speed test servers with location and latency information.
- [List Test Results](https://docs.xerobi.com/speed-api/endpoint/list-results.md): Retrieves all stored test results with pagination support.
- [Get Test Result](https://docs.xerobi.com/speed-api/endpoint/get-result.md): Retrieves detailed information for a specific test result by ID.
- [Get Statistics](https://docs.xerobi.com/speed-api/endpoint/get-statistics.md): Returns aggregate statistics for test results within a time range.
- [Comparison Report](https://docs.xerobi.com/speed-api/endpoint/comparison-report.md): Compares the latest test result with the previous one, showing differences and percentage changes.
- [Real-time Stream](https://docs.xerobi.com/speed-api/endpoint/realtime-stream.md): Server-Sent Events (SSE) endpoint that streams real-time progress updates during a full speed test.
- [NTP Servers](https://docs.xerobi.com/more/ntp-servers.md): Free NTP and Roughtime servers provided by Xerobi
- [Speed Test Server](https://docs.xerobi.com/more/speed-test.md): Ookla Speedtest server provided by Xerobi for internet speed testing
- [DNS Service](https://docs.xerobi.com/more/dns-service.md): Secure DNS service with filtering and encryption options
- [Changelog](https://docs.xerobi.com/changelog.md): Xerobi platform updates and API changes

## OpenAPI Specs

- [openapi](/certify-api/openapi.json)
- [openapi](/network-api/openapi.json)
- [openapi](/payment-api/openapi.json)
- [openapi](/rpki-api/openapi.json)
- [openapi](/sms-api/openapi.json)
- [openapi](/speed-api/openapi.json)

## Optional

- [Blog](https://blog.xerobi.com/)
- [Support](https://support.xerobi.com/)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.