Requirements

Requirements for international numbers and porting orders

List all requirements

List all requirements with filtering, sorting, and pagination

SecuritybearerAuth
Request
query Parameters
filter[country_code]
string

Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code

Example: filter[country_code]=US
filter[phone_number_type]
string

Filters results to those applying to a specific phone_number_type

Enum: "local" "national" "toll-free"
Example: filter[phone_number_type]=local
filter[action]
string

Filters requirements to those applying to a specific action.

Enum: "ordering" "porting"
Example: filter[action]=porting
sort[]
string

Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

Enum: "action" "country_code" "locality" "phone_number_type"
Example: sort[]=country_code
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

Successful response

Response Schema: application/json
Array of objects (DocReqsRequirementList)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/requirements
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "action": "ordering",
      • "country_code": "FR",
      • "created_at": "2021-04-09T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "locality": "Nice",
      • "phone_number_type": "local",
      • "record_type": "requirement",
      • "requirements_types": [
        • {
          • "acceptance_criteria": {
            • "locality_limit": "Issued by the same country that the phone number belongs to",
            • "time_limit": "Current and not expired"
            },
          • "created_at": "2021-04-09T22:25:27.521Z",
          • "description": "Proves the customer has a physical address in the same locality as the phone number",
          • "example": "Utility bill, internet bill, phone bill, or lease",
          • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
          • "name": "Proof of Address",
          • "record_type": "requirement_type",
          • "type": "document",
          • "updated_at": "2021-04-12T20:20:20.020Z"
          }
        ],
      • "updated_at": "2021-04-12T20:20:20.020Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Retrieve a document requirement
Retrieve a document requirement record


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Uniquely identifies the requirement_type record


 
 Example:  a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa
Responses 
200
Successful response


Response Schema: application/json
object (DocReqsRequirement) 
 
action
string
Indicates whether this requirement applies to ordering, porting, or both


 Enum: "both" "ordering" "porting"  
country_code
string
The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies


 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the associated document


 
locality
string
The locality where this requirement applies


 
phone_number_type
string
Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.


 Enum: "local" "national" "toll_free"  
record_type
string
Identifies the type of the resource.


 
Array of objects (DocReqsRequirementType) 
Lists the requirement types necessary to fulfill this requirement


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was last updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/requirements/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "action": "ordering",
    • "country_code": "FR",
    • "created_at": "2021-04-09T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "locality": "Nice",
    • "phone_number_type": "local",
    • "record_type": "requirement",
    • "requirements_types": [
      • {
        • "acceptance_criteria": {
          • "locality_limit": "Issued by the same country that the phone number belongs to",
          • "time_limit": "Current and not expired"
          },
        • "created_at": "2021-04-09T22:25:27.521Z",
        • "description": "Proves the customer has a physical address in the same locality as the phone number",
        • "example": "Utility bill, internet bill, phone bill, or lease",
        • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
        • "name": "Proof of Address",
        • "record_type": "requirement_type",
        • "type": "document",
        • "updated_at": "2021-04-12T20:20:20.020Z"
        }
      ],
    • "updated_at": "2021-04-12T20:20:20.020Z"
    }
}