Zernio
Zernio
API Reference

Branded Calling

List pre-approved call reasonsGETList registered businessesGETList caller identitiesGETList the numbers on a caller identityGETRegister a business for Branded CallingPOSTCreate a caller identityPOSTGet a registered businessGETGet a caller identityGETEdit or resubmit a caller identityPATCHDelete a registered businessDELETEDelete a caller identityDELETEAttach numbers to a verified identityPOSTConfirm the authorizer's codePOSTDetach numbers from an identityDELETEResend the authorizer's codePOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Branded Calling

Attach numbers to a verified identity

Files a Letter of Authorization signed by you (Zernio is named as the authorized agent managing the numbers) and opens a vetting batch of up to 15 US numbers you own. The batch is all-or-nothing: one ineligible number refuses the whole call. Each number shows the identity once its own status reaches verified. A number belongs to one identity at a time.

POST
/v1/branded-calling/identities/{id}/numbers

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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.brandedcalling.attachBrandedCallingNumbers({  path: {    id: 'abc123',  },  body: {    phoneNumberIds: [      'phonenumber_abc123',    ],    signature: {      imageBase64: 'string',    },  },});console.log(data);
{  "numbers": [    {      "phoneNumberId": "string",      "phoneNumber": "string",      "status": "submitted",      "rejectionReason": {        "code": "string",        "title": "string",        "detail": "string",        "message": "string"      },      "verifiedAt": "2019-08-24T14:15:22Z",      "addedAt": "2019-08-24T14:15:22Z"    }  ]}
Was this page helpful?

Delete a caller identity

Detaches its numbers and removes the identity at the carrier, which ends the monthly fee. Refused while an infringement claim is open.

Confirm the authorizer's code

The last customer step. On success the stored references are filed and the identity is submitted to carrier vetting in the same call (`in_review`). If a later step fails the identity stays `pending_email_verification` with the email already verified; calling again resumes from that step.

phoneNumberIds*array<string>

Phone number record ids (from GET /v1/phone-numbers). Active US numbers only.

Items1 <= items <= 15
signature*