Outpost DocsAPI ReferencePhones
Validate a phone number without adding it to the phone book
Returns the cached Pinpoint PhoneNumberValidate result, or calls Pinpoint and caches it. Does not create a phone-book row. Returns 429 when every configured Pinpoint region throttles, and does not cache that outcome.
x-api-key<token>
Project-scoped API key. Keys carry either the ADMIN or TENANT role; a route additionally requires that the key's role is listed in its x-required-roles. Machine-to-machine callers should use this.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/phones/validate" \ -H "Content-Type: application/json" \ -d '{ "phoneNumber": "string" }'{ "carrier": "string", "city": "string", "cleansedPhoneNumberE164": "string", "cleansedPhoneNumberNational": "string", "country": "string", "countryCodeIso2": "string", "countryCodeNumeric": "string", "county": "string", "phoneType": "string", "phoneTypeCode": 0, "timezone": "string", "zipCode": "string"}