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

Edit or resubmit a caller identity

Allowed while the identity is requested, changes_requested or rejected. Answering a change request (send reviewAnswers keyed by point id, and any edited fields) puts it back in review. On a carrier rejection the edits are applied at the carrier and the identity is resubmitted straight away.

PATCH
/v1/branded-calling/identities/{id}

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.updateBrandedCallingIdentity({  path: {    id: 'abc123',  },  body: {    displayName: 'Example',    callReasons: [      'string',    ],    logoUrl: 'https://example.com',  },});console.log(data);
{  "id": "string",  "enterpriseId": "string",  "displayName": "string",  "callReasons": [    "string"  ],  "callReasonsPreApproved": true,  "logoUrl": "string",  "authorizer": {    "name": "string",    "email": "user@example.com"  },  "references": {    "business": [      {        "fullName": "string",        "jobTitle": "string",        "organization": "string",        "relationshipToRegistrant": "string",        "phoneNumber": "string",        "email": "user@example.com",        "timezone": "string"      },      {        "fullName": "string",        "jobTitle": "string",        "organization": "string",        "relationshipToRegistrant": "string",        "phoneNumber": "string",        "email": "user@example.com",        "timezone": "string"      }    ],    "financial": {      "fullName": "string",      "jobTitle": "string",      "organization": "string",      "relationshipToRegistrant": "string",      "phoneNumber": "string",      "email": "user@example.com",      "timezone": "string"    }  },  "status": "requested",  "rejectionReasons": [    {      "code": "string",      "title": "string",      "detail": "string",      "message": "string"    }  ],  "reviewNote": "string",  "reviewRequest": {    "id": "string",    "intro": "string",    "points": [      {        "id": "string",        "title": "string",        "detail": "string",        "answer": "text"      }    ]  },  "emailVerifiedAt": "2019-08-24T14:15:22Z",  "submittedAt": "2019-08-24T14:15:22Z",  "verifiedAt": "2019-08-24T14:15:22Z",  "expiringAt": "2019-08-24T14:15:22Z",  "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"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
Was this page helpful?

Get a caller identity

Poll this for review and vetting progress, or subscribe to `branded_calling.identity.status_updated`.

Delete a registered business

Refused while the business still has caller identities (delete those first).

displayName?string

Shown on the callee's screen. No emoji.

Length1 <= length <= 35
callReasons?array<>

1 to 10 reasons you call, each up to 64 characters. Pick from GET /v1/branded-calling/call-reasons to skip manual vetting.

Items1 <= items <= 10
logoUrl?string

HTTPS URL of a PNG, JPEG, WebP or SVG logo. Zernio converts it to the 256x256 BMP the carriers require and hosts it.

authorizer?
references?
reviewAnswers?

One entry per point id of the open reviewRequest.

reviewNote?string
Lengthlength <= 4000