{ "opencollection": "1.0.0", "info": { "name": "Telnyx Access Tokens Verification Requests API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Verification Requests", "type": "folder" }, "items": [ { "info": { "name": "List Verification Requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query", "description": "\n Request this many records per page\n\n This value is automatically clamped if the provided value is too large.\n " }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "phone_number", "value": "", "type": "query" }, { "name": "business_name", "value": "", "type": "query", "description": "Filter verification requests by business name" } ] }, "docs": "Get a list of previously-submitted tollfree verification requests" }, { "info": { "name": "Submit Verification Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests", "body": { "type": "json", "data": "{}" } }, "docs": "Submit a new tollfree verification request" }, { "info": { "name": "Get Verification Request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single verification request by its ID." }, { "info": { "name": "Update Verification Request", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken." }, { "info": { "name": "Delete Verification Request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a verification request\n\nA request may only be deleted when when the request is in the \"rejected\" state.\n\n* `HTTP 200`: request successfully deleted\n* `HTTP 400`: request exists but can't be deleted (i.e. not rejected)\n* `HTTP 404`: request unknown or already deleted" }, { "info": { "name": "Get Verification Request Status History", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id/status_history", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "page[number]", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" } ] }, "docs": "Get the history of status changes for a verification request.\n\nReturns a paginated list of historical status changes including the reason for each change and when it occurred." } ] } ], "bundled": true }