> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # List verified caller IDs GET https://%7BYour_Space_Name%7D.signalwire.com/api/relay/rest/verified_caller_ids Lists external phone numbers your SignalWire project has submitted for outbound caller-ID verification. Verified Caller IDs let calls present a number the project does not own; project-owned numbers are managed through [Phone Numbers](/docs/apis/rest/phone-numbers/list-phone-numbers) and do not need this verification flow. Results are sorted by creation date, most recent first. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/verified-caller-id/list-verified-caller-ids ## Authentication - `Authorization` header (basic auth, required) — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` ## Request ### Query parameters - `filter_name` (string, optional) — String representing the name assigned to the caller ID. Will return all Verified Caller IDs containing this value as a substring. - `filter_number` (string, optional) — String representing the number assigned to the caller ID. Will return all Verified Caller IDs containing this value as a substring. ## Response ### 200 The request has succeeded. - `links` (PaginationLinks, optional) — Pagination links. - `data` (list of VerifiedCallerID, optional) — List of verified caller IDs. ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### PaginationLinks Pagination links for list responses. - `self` (string, required) — Link to the current page. - `first` (string, required) — Link to the first page. - `next` (string, optional) — Link to the next page. Only present when there are more results. - `prev` (string, optional) — Link to the previous page. Only present when not on the first page. ### VerifiedCallerID Verified caller ID model. - `id` (string, required) — The unique identifier of the Verified Caller ID on SignalWire. - `number` (string, required) — String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format. - `verified` (boolean, required) — A boolean representing whether the number has been verified or not. - `type` (string, optional) — The type of the returned object, this should be verified_caller_id. - `name` (string, optional) — String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided. - `extension` (string, optional) — String representing the extension of the phone number for the caller ID. This is only used when placing the verification call. - `verified_at` (datetime, optional) — Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null. - `status` (enum, optional) — The verification status for the caller ID. - Allowed values: `Verified`, `Awaiting Verification` ## Examples **Response** ```json { "links": { "self": "string", "first": "string", "next": "string", "prev": "string" }, "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "number": "+15551234567", "verified": false, "type": "verified_caller_id", "name": "C-3P0", "extension": "1234", "verified_at": "2024-01-15T09:30:00Z", "status": "Awaiting Verification" } ] } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids'; const credentials = btoa(":"); const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids" req, _ := http.NewRequest("GET", url, nil) req.SetBasicAuth("", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = ["Authorization": "Basic \(credentials)"] let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```