Dry-run a caller identity before creating it
Validates the exact body POST /v1/branded-calling/identities takes and runs
the same deterministic lints the review runs on it without creating anything,
with the same codes and fields the queued identity's findings carry. A block
finding is what the review would bounce (two references sharing a phone, a
reference inside the business, an invalid timezone); a warn finding slows
vetting (a display name that does not read as the business, a call reason
outside the carrier catalogue, a public-mailbox authorizer, a logo that does
not answer). ok is true when there is no block.
Authorization
bearerAuth 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.
Same body as createBrandedCallingIdentity.
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.preflightBrandedCallingIdentity({ body: { enterpriseId: 'enterprise_abc123', displayName: 'Example', callReasons: [ 'string', ], authorizer: { name: 'Example', email: 'user@example.com', }, references: { business: [ { fullName: 'Example', phoneNumber: 'string', email: 'user@example.com', timezone: 'string', }, ], financial: { fullName: 'Example', phoneNumber: 'string', email: 'user@example.com', timezone: 'string', }, }, },});console.log(data);{ "ok": true, "findings": [ { "code": "display-name-mismatch", "severity": "block", "field": "string", "message": "string" } ]}