Get a carrier registration
Poll this for approval progress after starting a registration.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sms.getSmsRegistration({ path: { id: 'abc123', },});console.log(data);{ "id": "string", "registrationType": "standard_10dlc", "status": "pending", "brandStatus": "string", "campaignStatus": "string", "declineReason": "string", "phoneNumbers": [ "string" ], "awaitingOtp": true, "adminReviewNote": "string", "reviewRequest": { "id": "string", "intro": "string", "points": [ { "id": "string", "title": "string", "detail": "string", "answer": "text" } ] }, "campaignContent": { "messageFlow": "string", "sample1": "string", "sample2": "string" }}Start a carrier registration
Starts the US carrier registration that a number needs before SMS delivers: 10DLC (standard company or sole-proprietor) or toll-free verification. 10DLC needs `brand` + `campaign`; toll-free needs `tollFree`. Approval is asynchronous; poll `GET /v1/sms/registrations/{id}` (sole-prop registrations first need the OTP step: a code is texted to the brand's mobile number, submit it via `/verify-otp`). Already have an approved registration? Add another number to it with `POST /v1/phone-numbers/{id}/sms/reuse-registration` instead of registering (and paying the carrier brand fee) again. Rather have your client fill in the legal business details? Create a share link with `POST /v1/sms/registrations/share`.
Create a registration share link
Creates a single-use, expiring link (valid 7 days) that lets someone else (whoever has the legal business details) fill in the carrier registration form for one of your numbers, without a Zernio login. The registration is created under your account once the form is submitted.