RoutingToll free verification
Refresh a toll-free verification request's status
Ask the carrier for this request's current status and write it back immediately, rather than waiting for the periodic check Tandem already runs on every pending request. Each pending number's smsCapability updates to match: enabled once verified, disabled if denied.
Authorization
bearerAuth AuthorizationBearer <token>
A Tandem bearer token. Requests are scoped to the organization the token belongs to; no organization header is required.
In: header
Path Parameters
tfvRequestId*string
The toll-free verification request's unique ID.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/sms-registration/refresh/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" }}