phone numbers

rent a number

rent a number from the inventory. the first month’s rent is taken from the wallet up front, then the KYC goes to the carrier; the rental then moves through kyc_submitted → kyc_accepted → purchasing → active (poll GET /v1/phone-numbers/{number_id}, its timeline says where it is). a short wallet parks the rental in funding until auto-pay tops it up.

with documents — multipart/form-data: a data field holding the JSON below and the document files in documents order (pdf, jpeg or png, 5 MB each). KYC already verified (see verifiedKyc on the requirements) — a plain JSON body with just requestedNumber.

POST

phone-numbers

rent a number

curl --request POST \
  --url https://silk-api.rumik.ai/v1/phone-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestedNumber": "918046800123",
  "searchFilters": {
    "pattern": "8046"
  }
}
'

import requests

url = "https://silk-api.rumik.ai/v1/phone-numbers"

payload = {
    "requestedNumber": "918046800123",
    "searchFilters": { "pattern": "8046" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({requestedNumber: '918046800123', searchFilters: {pattern: '8046'}})
};

fetch('https://silk-api.rumik.ai/v1/phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://silk-api.rumik.ai/v1/phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'requestedNumber' => '918046800123',
    'searchFilters' => [
        'pattern' => '8046'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://silk-api.rumik.ai/v1/phone-numbers"

	payload := strings.NewReader("{\n  \"requestedNumber\": \"918046800123\",\n  \"searchFilters\": {\n    \"pattern\": \"8046\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://silk-api.rumik.ai/v1/phone-numbers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"requestedNumber\": \"918046800123\",\n  \"searchFilters\": {\n    \"pattern\": \"8046\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"requestedNumber\": \"918046800123\",\n  \"searchFilters\": {\n    \"pattern\": \"8046\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019f7d21-3c5f-7e60-9b7c-8d9e0f1a2b3c",
  "status": "kyc_submitted",
  "requestedNumber": "918046800123",
  "number": null,
  "e164": null,
  "alias": null,
  "numberType": "local",
  "countryIso": "IN",
  "region": "Karnataka",
  "city": "Bangalore",
  "monthlyRentalRateUsd": "2.50000",
  "setupRateUsd": "0.00000",
  "voiceRateUsd": "0.00787",
  "monthlyRentNanos": 236250000000,
  "setupNanos": 0,
  "voiceRateNanos": 743715000,
  "outboundRateUsd": "0.01000",
  "outboundRateNanos": 945000000,
  "outboundUnitSeconds": 30,
  "prepaidNanos": 236250000000,
  "currency": "INR",
  "rentedAt": null,
  "nextRenewalAt": null,
  "lastRenewalChargedFor": "2026-09-11T10:30:00Z",
  "renewalAttempts": 0,
  "renewalLastError": null,
  "releaseReason": null,
  "releasedAt": null,
  "lastError": null,
  "userAgentId": null,
  "agentName": null,
  "compliance": null,
  "timeline": [
    {
      "key": "prepaid",
      "label": "first month's rent deducted",
      "state": "done",
      "at": "2026-09-11T10:00:05Z",
      "detail": null
    },
    {
      "key": "submitted",
      "label": "documents submitted",
      "state": "done",
      "at": "2026-09-11T10:00:06Z",
      "detail": null
    },
    {
      "key": "verification",
      "label": "verification",
      "state": "active",
      "at": null,
      "detail": null
    },
    {
      "key": "purchase",
      "label": "number purchase",
      "state": "pending",
      "at": null,
      "detail": null
    },
    {
      "key": "active",
      "label": "number active",
      "state": "pending",
      "at": null,
      "detail": null
    }
  ],
  "events": [],
  "createdAt": "2026-09-11T10:00:00Z",
  "updatedAt": "2026-09-11T10:30:00Z"
}

Authorizations

Authorization

string

header

required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Body

the rental payload — the JSON body, or the data field of the multipart form.

requestedNumber

string

required

the number to rent, as returned by the search (number, bare digits, or e164).

Example:

"918046800123"

searchFilters

object

the filters the number was found with (pattern, city), so a substitute can be picked from the same search if the number is taken meanwhile.

Show child attributes

endUser

object

the business renting the number: name (required, the legal name), email, address_line1, address_line2, city, state, postal_code, country, registration_number. required when documents are sent.

Show child attributes

documents

object[]

one entry per required document type from the requirements: documentTypeId and its dataFields. the files go in the multipart files field, in this order.

Show child attributes

Response

created.

a number rented through rumik, with its lifecycle.

string<uuid>

required

the rental's id.

status

string

required

funding → kyc_submitted → kyc_accepted → purchasing → awaiting_funds → active; kyc_rejected, past_due, releasing, released, failed.

numberType

string

required

countryIso

string

required

currency

string

required

the wallet's currency (INR).

timeline

TimelineStep · object[]

required

the rental's progress, step by step: key, label, state (done | active | pending | failed), at, detail.

Show child attributes

events

object[]

required

the raw event log.

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

requestedNumber

string | null

what was asked for.

number

string | null

the number owned (bare digits), once purchased.

e164

string | null

the same in E.164 — what fromNumber on POST /v1/calls takes.

alias

string | null

region

string | null

city

string | null

monthlyRentalRateUsd

string | null

setupRateUsd

string | null

voiceRateUsd

string | null

monthlyRentNanos

integer | null

the monthly rent in the wallet's currency, in nanos (billionths).

setupNanos

integer | null

one-off setup fee, nanos.

voiceRateNanos

integer | null

inbound per-minute carrier rate, nanos.

outboundRateUsd

string | null

outboundRateNanos

integer | null

outbound per-minute carrier rate, nanos, billed per outboundUnitSeconds.

outboundUnitSeconds

integer | null

the outbound billing pulse (30 s for India).

prepaidNanos

integer

default:0

the first charge collected before the KYC went out.

rentedAt

string<date-time> | null

when the number was purchased.

nextRenewalAt

string<date-time> | null

when the next month's rent is due.

lastRenewalChargedFor

string<date-time> | null

renewalAttempts

integer

default:0

renewalLastError

string | null

releaseReason

string | null

why it was released (user, non_payment, …).

releasedAt

string<date-time> | null

lastError

string | null

the last carrier or billing error, if any.

userAgentId

string<uuid> | null

the agent connected to the number, or null.

agentName

string | null

that agent's name.

compliance

ComplianceApplication · object | null

the KYC application: status, rejectionReason, attempts, history.

Show child attributes

rent a number

curl --request POST \
  --url https://silk-api.rumik.ai/v1/phone-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestedNumber": "918046800123",
  "searchFilters": {
    "pattern": "8046"
  }
}
'

import requests

url = "https://silk-api.rumik.ai/v1/phone-numbers"

payload = {
    "requestedNumber": "918046800123",
    "searchFilters": { "pattern": "8046" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({requestedNumber: '918046800123', searchFilters: {pattern: '8046'}})
};

fetch('https://silk-api.rumik.ai/v1/phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://silk-api.rumik.ai/v1/phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'requestedNumber' => '918046800123',
    'searchFilters' => [
        'pattern' => '8046'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://silk-api.rumik.ai/v1/phone-numbers"

	payload := strings.NewReader("{\n  \"requestedNumber\": \"918046800123\",\n  \"searchFilters\": {\n    \"pattern\": \"8046\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://silk-api.rumik.ai/v1/phone-numbers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"requestedNumber\": \"918046800123\",\n  \"searchFilters\": {\n    \"pattern\": \"8046\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"requestedNumber\": \"918046800123\",\n  \"searchFilters\": {\n    \"pattern\": \"8046\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "019f7d21-3c5f-7e60-9b7c-8d9e0f1a2b3c",
  "status": "kyc_submitted",
  "requestedNumber": "918046800123",
  "number": null,
  "e164": null,
  "alias": null,
  "numberType": "local",
  "countryIso": "IN",
  "region": "Karnataka",
  "city": "Bangalore",
  "monthlyRentalRateUsd": "2.50000",
  "setupRateUsd": "0.00000",
  "voiceRateUsd": "0.00787",
  "monthlyRentNanos": 236250000000,
  "setupNanos": 0,
  "voiceRateNanos": 743715000,
  "outboundRateUsd": "0.01000",
  "outboundRateNanos": 945000000,
  "outboundUnitSeconds": 30,
  "prepaidNanos": 236250000000,
  "currency": "INR",
  "rentedAt": null,
  "nextRenewalAt": null,
  "lastRenewalChargedFor": "2026-09-11T10:30:00Z",
  "renewalAttempts": 0,
  "renewalLastError": null,
  "releaseReason": null,
  "releasedAt": null,
  "lastError": null,
  "userAgentId": null,
  "agentName": null,
  "compliance": null,
  "timeline": [
    {
      "key": "prepaid",
      "label": "first month's rent deducted",
      "state": "done",
      "at": "2026-09-11T10:00:05Z",
      "detail": null
    },
    {
      "key": "submitted",
      "label": "documents submitted",
      "state": "done",
      "at": "2026-09-11T10:00:06Z",
      "detail": null
    },
    {
      "key": "verification",
      "label": "verification",
      "state": "active",
      "at": null,
      "detail": null
    },
    {
      "key": "purchase",
      "label": "number purchase",
      "state": "pending",
      "at": null,
      "detail": null
    },
    {
      "key": "active",
      "label": "number active",
      "state": "pending",
      "at": null,
      "detail": null
    }
  ],
  "events": [],
  "createdAt": "2026-09-11T10:00:00Z",
  "updatedAt": "2026-09-11T10:30:00Z"
}

documentation

sdk

integrations

cookbook

api reference

rent a number

Authorizations

Body

Response