Requirement Types

Types of requirements for international numbers and porting orders

List all requirement types

List all requirement types ordered by created_at descending

SecuritybearerAuth
Request
query Parameters
filter[name][contains]
string

Filters requirement types to those whose name contains a certain string.

Example: filter[name][contains]=utility bill
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: "created_at" "name" "updated_at"
Example: sort[]=country_code
Responses
200

Successful response

Response Schema: application/json
Array of objects (DocReqsRequirementTypeList)
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/requirement_types
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "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"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Retrieve a requirement types
Retrieve a requirement type by id


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


 
 Example:  a38c217a-8019-48f8-bff6-0fdd9939075b
Responses 
200
Successful response


Response Schema: application/json
object (DocReqsRequirementType) 
 
object
Specifies objective criteria for acceptance


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


 
description
string
Describes the requirement type


 
example
string
Provides one or more examples of acceptable documents


 
id
string <uuid> 
Identifies the associated document


 
name
string
A short descriptive name for this requirement_type


 
record_type
string
Identifies the type of the resource


 
type
string
Defines the type of this requirement type


 Enum: "document" "address" "textual"  
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/requirement_types/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "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"
    }
}