Submit a toll-free verification request
Submit one business profile for up to 10 toll-free numbers at once. Every number must belong to your organization and be toll-free (NPA 800, 833, 844, 855, 866, 877, or 888); a local number, an unknown number, or a number already on a request is rejected. A number denied on an earlier request moves forward by resubmitting that request while the carrier takes it back. Once it won't (the number's resubmitAllowed is false, or 7 days have passed since its deniedAt), the number can go in a new submission instead: its old verification is withdrawn at the carrier first, and the number is taken off its old request. Until the carrier decides, each number's status is pending and its smsCapability stays pending. A 400 with code TFV_REJECTED means the carrier refused the submission; its message gives the carrier's reasons, field by field where it names them.
Authorization
bearerAuth A Tandem bearer token. Requests are scoped to the organization the token belongs to; no organization header is required.
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
curl -X POST "https://example.com/v1/sms-registration/tfv" \ -H "Content-Type: application/json" \ -d '{ "numberIds": [ "string" ], "profile": { "businessName": "string", "businessEntityType": "SOLE_PROPRIETOR", "businessAddress": { "addressLine1": "string", "city": "string", "state": "string", "zip": "string", "websiteUrl": "string" }, "businessContact": { "firstName": "string", "lastName": "string", "email": "string", "phone": "string" }, "useCase": "string", "useCaseSummary": "string", "productionMessageContent": "string", "estimatedMonthlyVolume": 10, "optIn": { "description": "string", "images": [ { "kind": "upload", "key": "string" } ] } } }'{ "id": "string", "numbers": [ { "numberId": "string", "phoneNumber": "string", "status": "pending", "denialReason": "string", "resubmitAllowed": true, "deniedAt": "2019-08-24T14:15:22Z" } ], "profile": { "businessName": "string", "businessDba": "string", "businessEntityType": "SOLE_PROPRIETOR", "businessRegistrationNumber": "string", "businessRegistrationType": "EIN", "businessRegistrationIssuingCountry": "string", "businessAddress": { "addressLine1": "string", "addressLine2": "string", "city": "string", "state": "string", "zip": "string", "websiteUrl": "string" }, "businessContact": { "firstName": "string", "lastName": "string", "email": "string", "phone": "string" }, "useCase": "string", "useCaseSummary": "string", "productionMessageContent": "string", "estimatedMonthlyVolume": 10, "optIn": { "description": "string", "images": [ { "kind": "upload", "key": "string" } ], "confirmationResponse": "string" }, "privacyPolicyUrl": "string", "termsUrl": "string", "additionalInformation": "string" }, "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}{ "error": { "code": "string", "message": "string" }}{ "error": { "code": "string", "message": "string" }}{ "error": { "code": "string", "message": "string" }}