get rental requirements

curl --request GET \
  --url https://silk-api.rumik.ai/v1/phone-numbers/requirements \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://silk-api.rumik.ai/v1/phone-numbers/requirements', 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/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://silk-api.rumik.ai/v1/phone-numbers/requirements")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "configured": true,
  "countryIso": "<string>",
  "numberType": "<string>",
  "userType": "<string>",
  "eligibility": {
    "eligible": true,
    "billingMode": "<string>",
    "currency": "<string>",
    "reason": "<string>",
    "walletAvailableNanos": 0,
    "mandateRequired": true
  },
  "autoPay": {
    "active": true,
    "sufficient": true,
    "status": "<string>",
    "topUpAmountNanos": 0,
    "thresholdAmountNanos": 0
  },
  "rentalPeriodSeconds": 123,
  "suspendedAt": "2023-11-07T05:31:56Z",
  "suspendedReason": "<string>",
  "requirements": {
    "countryIso": "<string>",
    "numberType": "<string>",
    "userType": "<string>",
    "documentTypes": [
      {
        "documentTypeId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "proofRequired": true,
        "requiredFields": [
          {
            "fieldName": "<string>",
            "friendlyName": "<string>",
            "helpText": "<string>",
            "fieldType": "string",
            "required": true,
            "format": "<string>",
            "enums": [
              "<string>"
            ],
            "minLength": 123,
            "maxLength": 123
          }
        ]
      }
    ],
    "requirementId": "<string>"
  },
  "verifiedKyc": {
    "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "plivoComplianceId": "<string>",
    "businessName": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z"
  },
  "autoPayMinimum": {
    "currency": "<string>",
    "monthlyRentNanos": 123,
    "reserveNanos": 123,
    "reserveRatio": "<string>",
    "minimumNanos": 123,
    "monthlyRentalRateUsd": "<string>",
    "fxUsdToCurrency": "<string>",
    "firstChargeNanos": 0,
    "setupNanos": 123,
    "setupRateUsd": "<string>"
  }
}

{
  "error": "Invalid API key",
  "code": "unauthorized"
}

{
  "error": "This API key lacks the 'agent' scope",
  "code": "forbidden_scope"
}

{
  "error": "Rate limit exceeded",
  "code": "rate_limited",
  "limit": 100,
  "current": 101
}

{
  "error": "Phone number rental is not available right now",
  "code": "telephony_not_configured"
}