{ "openapi": "3.0.1", "info": { "title": "SiteVerdict — Phone Number Validator & Formatter (Bulk)", "description": "Validate and format phone numbers in bulk for 240+ countries: valid/possible, E.164, international and national formats, mobile/landline/VoIP/toll-free type, country, duplicates and fiction/test ranges. Offline metadata, no lookups of people.", "version": "1.0", "x-build-id": "AyziXWhmnAgbwZRi6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/siteverdict~siteverdict-phone-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-phone-validator", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/siteverdict~siteverdict-phone-validator/runs": { "post": { "operationId": "runs-sync-siteverdict-siteverdict-phone-validator", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/siteverdict~siteverdict-phone-validator/run-sync": { "post": { "operationId": "run-sync-siteverdict-siteverdict-phone-validator", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "phoneNumbers": { "title": "Phone numbers", "type": "array", "description": "Numbers in any common format: +44 7700 900123, (020) 7946 0018, 001-202-555-0143, 07700900123 ext. 12. Numbers without a + prefix are read using the default country.", "items": { "type": "string" } }, "defaultCountry": { "title": "Default country (ISO code)", "type": "string", "description": "Two-letter country code (GB, US, IN, DE, AU...) used for numbers written without a +country code. Leave empty to accept only international (+) numbers." }, "text": { "title": "Paste numbers or text", "type": "string", "description": "One number per line, or free text (e-mails, notes) when \"Find numbers inside text\" is on. Up to 2 million characters." }, "extractFromText": { "title": "Find numbers inside text", "type": "boolean", "description": "Scan the pasted text for phone numbers instead of reading it line by line.", "default": false }, "records": { "title": "Records (JSON)", "type": "array", "description": "Optional objects like {\"phone\": \"07700 900123\", \"country\": \"GB\", \"label\": \"CRM-42\"}. A per-record country overrides the default country; the label is echoed back so you can join results to your data." }, "datasetId": { "title": "Dataset with numbers", "type": "string", "description": "Optional: ID of an Apify dataset whose items contain phone numbers (e.g. the output of another Actor)." }, "datasetField": { "title": "Phone field in that dataset", "type": "string", "description": "Field name that holds the number in each dataset item.", "default": "phone" }, "datasetCountryField": { "title": "Country field in that dataset (optional)", "type": "string", "description": "Field name holding a 2-letter country code per item." }, "dedupe": { "title": "Remove duplicates", "type": "boolean", "description": "Output each distinct number (same E.164 + extension) once. Duplicates are not charged.", "default": true }, "onlyValid": { "title": "Only output valid numbers", "type": "boolean", "description": "Drop invalid numbers from the dataset (they still appear in the summary counts and are not charged).", "default": false }, "maskNumbers": { "title": "Mask numbers in output", "type": "boolean", "description": "Privacy mode: hide all but the first 2 and last 3 digits in the output (validation still uses the full number).", "default": false }, "includeHash": { "title": "Add SHA-256 hash of E.164", "type": "boolean", "description": "Adds a salted SHA-256 of the E.164 number so you can match records without storing the number.", "default": false }, "hashSalt": { "title": "Hash salt (secret)", "type": "string", "description": "Optional secret salt for the hash. Never logged or output." }, "writeCsv": { "title": "Save CSV file", "type": "boolean", "description": "Also save NUMBERS.csv to the key-value store.", "default": true }, "maxNumbers": { "title": "Max numbers", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety cap for one run (max 100,000).", "default": 100000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }