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

Register a business for Branded Calling

Stores the legal entity behind your caller identities. Nothing is filed with the carrier until the business's first identity passes review. Only businesses registered in the US or Canada qualify (a FEIN or Canadian equivalent is required); any other country returns 422.


POST
/v1/branded-calling/enterprises

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

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.createBrandedCallingEnterprise({  body: {    legalName: 'Example',    doingBusinessAs: 'string',    organizationType: 'commercial',    organizationLegalType: 'corporation',    countryCode: 'string',    jurisdictionOfIncorporation: 'string',    website: 'https://example.com',    fein: 'string',    industry: 'string',    numberOfEmployees: '1-10',    organizationContact: {      firstName: 'Example',      lastName: 'Example',      email: 'user@example.com',      phoneNumber: 'string',    },    billingContact: {      firstName: 'Example',      lastName: 'Example',      email: 'user@example.com',      phoneNumber: 'string',    },    physicalAddress: {      streetAddress: 'string',      city: 'string',      administrativeArea: 'string',      postalCode: 'string',      country: 'string',    },    billingAddress: {      streetAddress: 'string',      city: 'string',      administrativeArea: 'string',      postalCode: 'string',      country: 'string',    },  },});console.log(data);
{  "id": "string",  "legalName": "string",  "doingBusinessAs": "string",  "organizationType": "commercial",  "organizationLegalType": "corporation",  "countryCode": "US",  "jurisdictionOfIncorporation": "string",  "website": "string",  "feinLast4": "string",  "industry": "string",  "numberOfEmployees": "1-10",  "organizationContact": {    "firstName": "string",    "lastName": "string",    "email": "user@example.com",    "jobTitle": "string",    "phoneNumber": "string"  },  "billingContact": {    "firstName": "string",    "lastName": "string",    "email": "user@example.com",    "jobTitle": "string",    "phoneNumber": "string"  },  "physicalAddress": {    "streetAddress": "string",    "extendedAddress": "string",    "city": "string",    "administrativeArea": "string",    "postalCode": "string",    "country": "string"  },  "billingAddress": {    "streetAddress": "string",    "extendedAddress": "string",    "city": "string",    "administrativeArea": "string",    "postalCode": "string",    "country": "string"  },  "registered": true,  "createdAt": "2019-08-24T14:15:22Z"}
Was this page helpful?

List the numbers on a caller identity

Previous Page

Create a caller identity

A caller identity is what the callee sees: display name, logo and call reasons, backed by a registered business and three references the carrier vetting team phones. It starts in Zernio review (`requested`). Once approved, the carrier emails the authorizer a 6-digit code; confirm it with the verify-email endpoint and the identity goes into carrier vetting on its own. Track it with `GET` or the `branded_calling.identity.status_updated` webhook. Billing: $100 per identity per month, the first month charged when the identity is filed with the carrier and not refunded if the carrier rejects it, then monthly while the identity exists. Branded calls add $0.10 each, counted on every outbound call from a verified branded number to a US destination (whether or not the callee's carrier displayed the branding); the surcharge shows as `brandedCallUSD` on the call's billing and in `GET /v1/voice/calls/estimate` when you pass `from`.

legalName*string

Exactly as on the tax record.

Length3 <= length <= 64
doingBusinessAs*string
Lengthlength <= 255
organizationType*string

Value in

  • "commercial"
  • "government"
  • "non_profit"
organizationLegalType*string

Value in

  • "corporation"
  • "llc"
  • "partnership"
  • "nonprofit"
  • "other"
countryCode*string

ISO 3166-1 alpha-2. US or CA.

jurisdictionOfIncorporation*string

State, province or country of registration.

Lengthlength <= 255
website*string
Formaturi
fein*string

US Federal Employer Identification Number (NN-NNNNNNN) or the Canadian equivalent. Stored encrypted; only the last four digits are ever returned.

industry*string

One of the carrier industry labels, e.g. technology, healthcare, retail, finance, legal, insurance, real estate, logistics, education.

numberOfEmployees*string

Value in

  • "1-10"
  • "11-50"
  • "51-200"
  • "201-500"
  • "501-2000"
  • "2001-10000"
  • "10001+"
organizationContact*
billingContact*
physicalAddress*
billingAddress*