Verified Numbers API

Verified Numbers API

List verified phone numbers

Gets a paginated list of Verified Numbers.

SecuritybearerAuth
Request
query Parameters
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 (Verified Number)
object (PaginationMeta)
400

Bad Request

401

Unauthorized

422

Unprocessable Entity

get/verified_numbers
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "phone_number": "+13123958493",
      • "record_type": "verified_number",
      • "verified_at": "2023-02-02T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Initiate Number Verification
Initiates phone number verification procedure


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Parameters that can be defined when making a verification request


phone_number
required
string
The phone number to be verified.


 
verification_method
required
string
The verification method to use.


 Enum: "sms" "call"  
Responses 
200
Successful response


Response Schema: application/json
object (NumberVerification) 
 
phone_number
string
The phone number to verify


 
verification_method
string
The verification method to use


 
400
Bad Request


401
Unauthorized


404
Resource not found


422
Unprocessable Entity


post/verified_numbers
Request samples 
application/json
{
  • "phone_number": "+13123958493",
  • "verification_method": "sms"
}
Response samples 
application/json
{
  • "data": {
    • "phone_number": "+13123958493",
    • "verification_method": "sms"
    }
}
Retrieve verified number
Retrieve a verified number


SecuritybearerAuth 
Request 
path Parameters
phone_number
required
string
The phone number to be looked up


 
 Example:  +18665552368
Responses 
200
Successful response


Response Schema: application/json
object (VerifiedNumber) 
 
phone_number
required
string
The phone number.


 
record_type
string
The type of record.


 
verified_at
string
ISO 8601 formatted date-time indicating when the resource was verified.


 
400
Bad Request


401
Unauthorized


404
Not Found


get/verified_numbers/{phone_number}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "phone_number": "+13123958493",
    • "record_type": "verified_number",
    • "verified_at": "2023-02-02T22:25:27.521Z"
    }
}
Delete verified number
Delete a verified number


SecuritybearerAuth 
Request 
path Parameters
phone_number
required
string
The phone number to be looked up


 
 Example:  +18665552368
Responses 
200
Successful response


Response Schema: application/json
object (VerifiedNumber) 
 
phone_number
required
string
The phone number.


 
record_type
string
The type of record.


 
verified_at
string
ISO 8601 formatted date-time indicating when the resource was verified.


 
400
Bad Request


401
Unauthorized


404
Resource not found


delete/verified_numbers/{phone_number}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "phone_number": "+13123958493",
    • "record_type": "verified_number",
    • "verified_at": "2023-02-02T22:25:27.521Z"
    }
}