List verification codes

GET 
/porting_orders/:id/verification_codes

Returns a list of verification codes for a porting order.

Request

Path Parameters

id uuidrequired

Porting Order id

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

filter[phone_number] string

Filter results by phone number

filter[phone_number][in][] string[]

Filter results by a list of phone numbers

filter[verified] boolean

Filter verification codes that have been verified or not

sort[] string

Possible values: [created_at, -created_at]

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Uniquely identifies this porting verification code

phone_number string

E164 formatted phone number

verified boolean

Indicates whether the verification code has been verified

porting_order_id uuid

Identifies the associated porting order

record_type string

Identifies the type of the resource.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "52090326-6533-4421-bcf4-bd0117cf3954",
      "phone_number": "+61424000001",
      "verified": true,
      "porting_order_id": "f28e6ecc-29a8-430b-bd0b-d93055f70604",
      "created_at": "2020-10-22T15:00:00.000Z",
      "updated_at": "2020-10-22T15:00:00.000Z"
    },
    {
      "id": "cf076b8e-645b-4040-8209-543c5909775f",
      "phone_number": "+61424000002",
      "verified": false,
      "porting_order_id": "f28e6ecc-29a8-430b-bd0b-d93055f70604",
      "created_at": "2020-10-22T15:00:00.000Z",
      "updated_at": "2020-10-22T15:00:00.000Z"
    }
  ],
  "meta": {
    "total_pages": 1,
    "total_results": 2,
    "page_number": 1,
    "page_size": 2
  }
}

401: Unauthorized

404: Resource not found

Loading...