Request resources through API

Request resources programmatically using the Resource Request API for automation and scale. Retrieve requirements, upload documents, submit requests, receive status updates, and manage the full lifecycle through the API.

Prerequisites

You need:

• Active Infobip account
• Completion of Resources and Numbers overview
• Understanding of Resource request procedure
• Familiarity with HTTP requests and JSON

API overview

The Resource Request API supports programmatic requests for alphanumeric senders and phone numbers. It provides a structured workflow: retrieve requirements, upload documents, submit requests, receive updates, and manage request status throughout the lifecycle.

The API enables automation at scale. Integrate resource requests directly into your platform workflows, track status through webhooks, and respond to validation feedback programmatically.

Supported request types [#supported-request-types-api-overview]

The Resource Request API supports three types of requests, each with different parameter requirements:

API workflow

The process of requesting resources through the API follows a structured sequence of endpoints.

Request statuses [#request-statuses-api-workflow]

When you submit a resource request through the API, it progresses through multiple statuses during validation and processing.

For UPDATE_REQUESTED or UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses, use the Update resource request endpoint to submit corrections.

Get requirements endpoint

Retrieve all required data and documentation fields for your specific resource type and country before submitting. This prevents validation failures by ensuring you gather all needed information upfront.

1. Specify the request type (ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE, or RCS_SENDER_LAUNCH).
2. Provide required parameters for your resource type.
3. The API returns a list of required fields with their data types and validation rules.

Possible responses:

• No requirements needed (Numbers): Empty object returned. The number requires no additional documentation or data.
• No offer (Numbers): No appropriate offers available for the specified parameters (Error: RES-NUM-LOOKUP404).
• No registration (Alphanumeric senders): Alphanumeric registration not available for this country (unsupported or country allows any sender).

All requests are validated for syntax correctness, authorization and permissions, required field presence, field-specific rules (length, format, and pattern), and compliance requirements.

Learn more

For detailed request schema, field definitions, and constraints, see Resource Request API - Get requirements.

Upload documents endpoint

Submit required documentation files that will be attached to your resource request. Use this endpoint only if your Get requirements response includes fields of type DOCUMENT.

1. For each required document field identified in requirements, prepare your document file.
2. Call the Upload documents endpoint with your file.
3. The API returns a document ID.
4. Use this document ID when submitting your resource request.

This two-step process (upload first, then reference in request) ensures documents are properly stored and linked to your request.

Learn more

For endpoint details and examples, see Resource Request API - Upload documents.

Submit resource request endpoint

Submit your resource request with all required data and documents after gathering requirements and uploading any files.

Before submitting:

• Submit only after you have gathered all requirements and uploaded any required documents.
• Some numbers do not require additional data. Always call Get requirements first.
• Submission may incur charges depending on the resource type.

Learn more

For complete request schema, field constraints, and examples, see Resource Request API - Submit resource request.

Receive updates webhook

Subscribe to status update webhooks to be notified when your request status changes, instead of polling the API. When your request status changes, the webhook delivers an event specifying the new status (COMPLETED, REJECTED, UPDATE_REQUESTED, and more).

This allows you to:

• Monitor request progress in real-time
• Automatically trigger actions when status changes
• Reduce polling overhead by receiving push notifications

Update resource request endpoint

Submit corrections or additional information when validation fails or Infobip requests clarification. Use this endpoint when automatic validation detected issues in your submitted data (UPDATE_REQUESTED status) or when an Infobip reviewer requested additional information (UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status).

1. Call Get resource requests to retrieve validation feedback in the requirementsFeedback array.
2. Update the problematic fields based on feedback.
3. Call Update resource request with the request identifier and corrected data.
4. The request re-enters the validation and review process.

Alternative: For alphanumeric sender requests only, you can also edit directly from the My requests page in the web interface.

Cancel resource request endpoint

Cancel a resource request at any time before completion.

1. Call Cancel resource request with the request identifier.
2. Request status changes to CANCELED.
3. The request is removed from the processing queue.

Alternative: You can also cancel through the web interface for both alphanumeric senders and number purchases.

Learn more

Resource Request API docs: complete endpoint reference for all resource request operations.