Get business verification

curl --request GET \
  --url https://sandbox.voice.miraiminds.co/v2/telephony/onboarding \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/telephony/onboarding"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/telephony/onboarding';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "id": "",
  "account": "mirai",
  "number_type": "local",
  "state": "not_started",
  "compliance_id": "",
  "request_id": "",
  "version": 0,
  "setup_state": "not_started",
  "business_defaults": {
    "name": "Mirai Motors Private Limited",
    "email": "accounts@example.com",
    "address_line1": "4th Floor, Example House, 12 MG Road",
    "address_line2": "Camp",
    "city": "Pune",
    "state": "Maharashtra",
    "postal_code": "411001",
    "registration_number": "27AAACM1234A1Z5"
  },
  "business_source": "company_profile"
}

Telephony

Get business verification

Where your business verification stands for one account and number_type. Read-only.

state is not_started until you submit, submitted while Plivo reviews it, then accepted or rejected (also possible: submission_failed, suspended, expired). setup_state turns ready when you can rent.

business_defaults are the company details you saved when going live, ready to reuse in the application; editing them in the application doesn’t change your billing details. Send this version when you submit (0 the first time).

GET

telephony

onboarding

Get business verification

curl --request GET \
  --url https://sandbox.voice.miraiminds.co/v2/telephony/onboarding \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/telephony/onboarding"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/telephony/onboarding';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "id": "",
  "account": "mirai",
  "number_type": "local",
  "state": "not_started",
  "compliance_id": "",
  "request_id": "",
  "version": 0,
  "setup_state": "not_started",
  "business_defaults": {
    "name": "Mirai Motors Private Limited",
    "email": "accounts@example.com",
    "address_line1": "4th Floor, Example House, 12 MG Road",
    "address_line2": "Camp",
    "city": "Pune",
    "state": "Maharashtra",
    "postal_code": "411001",
    "registration_number": "27AAACM1234A1Z5"
  },
  "business_source": "company_profile"
}

Authorizations

Authorization

string

header

required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Query Parameters

account

string

mirai, or your connection id

number_type

string

local | mobile | tollfree

Response

Not started

Get started

Agents

Calls

Flows

Tools and secrets

Campaigns

Do-not-call list

Phone numbers

Phone pools

Telephony

Transcriptions

Speech to text

Text to speech

Wallet

Reference

Get business verification

Authorizations

Query Parameters

Response