This documentation is built and maintained by the Flireo AI team to help you create, launch, and scale intelligent phone agents. Access the dashboard here.
Order number via verification group
Endpoint
POST /v1/verification-groups/{id}/order-numberPath Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | uuid | Yes | Verification group ID |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
phone_number | string | Yes | The phone number to order (from available numbers) |
Example Request
Example Response
{
"message": "Phone number ordered",
"data": {
"order_id": "660e8400-e29b-41d4-a716-446655440000",
"phone_number": "+31201234567",
"number_type": "local",
"status": "pending",
"verification_group": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Amsterdam Office"
},
"credits_used": 10,
"remaining_credits": 90
}
}Request JSON Schema
{
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "The phone number to order (from available-phone-numbers)"
}
},
"required": ["phone_number"]
}Response JSON Schema
{
"type": "object",
"properties": {
"message": { "type": "string" },
"data": {
"type": "object",
"properties": {
"order_id": { "type": "string", "format": "uuid" },
"phone_number": { "type": "string" },
"number_type": { "type": "string" },
"status": { "type": "string" },
"verification_group": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"name": { "type": "string", "nullable": true }
}
},
"credits_used": { "type": "integer" },
"remaining_credits": { "type": "integer" }
}
}
}
}Error Codes
| Code | HTTP Status | Description |
|---|---|---|
not_found | 404 | Verification group not found |
invalid_status | 400 | Group is not approved |
insufficient_credits | 402 | Not enough credits (need 10) |
invalid_parameters | 400 | Invalid phone number |
Track your order with phone number orders.
Modified at 2025-12-08 10:37:31