API v3

GET /number_requirements

What you must supply, per country and number type, before a number goes live: personal, business and address documents, and notes. Leave out country for every country.

Addresshttps://api.voicepro.plus/v3/number_requirements
Key permissionread

Fields

NameInType
countryquerystringISO 3166 alpha-2, for example DE.
limitqueryinteger
cursorquerystringnext_cursor from the previous page.

* required

Example

curl -X GET "https://api.voicepro.plus/v3/number_requirements?country=DE" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "list",
  "data": [
    {
      "object": "number_requirement",
      "country": "DE",
      "country_name": "Germany",
      "region": "Europe",
      "documentation_required": true,
      "number_types": [
        {
          "category": "landline",
          "personal": [
            "Name, last name",
            "Contact phone number",
            "German passport or ID copy"
          ],
          "business": [
            "Name, last name",
            "Contact phone number",
            "Company name",
            "German company incorporation certificate copy"
          ],
          "address": [
            "Address matching: the DID area code, address in the certificate/ID (street, building number, postal code, city and country)",
            "A copy of a utility bill (less than 6 months old)"
          ],
          "notes": [
            "We reserve the right in our sole discretion to request additional information at any stage of the registration process."
          ]
        },
        {
          "category": "tollfree",
          "personal": [
            "Name, last name",
            "Contact phone number",
            "Proof of allocation (Zuteilungsbescheid) from the German national regulator (BNetzA)"
          ],
          "business": [
            "Name, last name",
            "Contact phone number",
            "Company name",
            "Proof of allocation (Zuteilungsbescheid) from the German national regulator (BNetzA)"
          ],
          "address": [
            "Address in Germany (street, building number, postal code, city and country)"
          ],
          "notes": [
            "We reserve the right in our sole discretion to request additional information at any stage of the registration process."
          ]
        }
      ]
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

Every error has the same shape: { "error": { "type", "code", "message", "param", "request_id" } }.

missing_api_key401: No Authorization header, or not a Bearer key.
invalid_api_key401: The key is not recognised.
api_key_revoked401: The key was revoked in the portal.
api_key_expired401: The key passed the expiry date set on it.
missing_scope403: The key lacks the scope this endpoint needs; param names the scope.
ip_not_allowed403: The key has an IP allowlist and this request came from elsewhere.
account_not_active403: The workspace is suspended or closed.
invalid_parameter400: A query parameter or body field has a bad value; param names it.
missing_parameter400: A required parameter or field is missing; param names it.
unknown_parameter400: A parameter or field that this endpoint does not accept; param names it.
invalid_json400: The body is not valid JSON.
invalid_cursor400: The cursor is malformed, expired or from a different list.
invalid_time_range400: from or to is not an ISO 8601 date-time, or to is not after from.
range_too_long400: The time range is longer than this endpoint allows (stated in the endpoint).
rate_limited429: Too many requests for this key or for the whole account (the message says which); wait Retry-After seconds.
upstream_unavailable503: A network partner or data service behind this endpoint is unavailable.
network_action_unavailable503: This network action is not switched on for the account yet (for example SIM suspend).
internal_error500: Our fault. Quote the request_id to support.
service_unavailable503: API v3 itself is briefly unavailable (for example a configuration problem on our side); the rest of VoicePro is unaffected. Retry later.

More in Numbers