Skip to main content
This API lets you create a business profile for your end customers.

​
API Endpoint

POST
https://api.plivo.com/v1/Account/{auth_id}/Profile/

​
Arguments

profile_alias
string
required

A friendly name for your profile.

customer_type
string
required

Indicates the nature of your operations.

Allowed values: DIRECT, RESELLER.

Select RESELLER if your business provides communication services such as messaging and voice calling to other businesses.

entity_type
string
required

Indicates ownership of the company.

Allowed values: PRIVATE, PUBLIC, NON_PROFIT, GOVERNMENT, INDIVIDUAL.

company_name
string
required

Legal name of the company.

vertical
string
required

Indicates industry.

Allowed values: PROFESSIONAL, REAL_ESTATE, HEALTHCARE, HUMAN_RESOURCES, ENERGY,ENTERTAINMENT, RETAIL, TRANSPORTATION,AGRICULTURE,INSURANCE,POSTAL,EDUCATION,HOSPITALITY, FINANCIAL, POLITICAL, GAMBLING, LEGAL, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION

ein
integer

Employer Identification Number.

Plivo strongly recommends providing your EIN if your company is registered to unlock premium features like high throughput for Plivo products.

ein_issuing_country
string

The ISO country code of the country that issued the EIN.

address
object
required

Valid postal address of the company.

{"street": "","city": "","state": "","postal_code": "","country": ""}

state: A valid state code, e.g. TX for Texas.
postal_code: ZIP code.
country: ISO alpha-2 country code (US).

authorized_contact
object
required

Authorized contact person at the company.

”first_name”: “John”,
“last_name”: “Doe”,
“email”: “john@example.com”,
“title”: “Mr”,
“seniority”: “admin”,
“phone”: ""

Fields first_name and last_name are free-form.

email: Email address.
title: Salutation of the contact at the given company.
seniority: Allowed values: DIRECTOR, GM, VP, CEO, CFO, GENERAL_COUNSEL, OTHER.
phone: Company phone number in E.164 format.
stock_symbol
string

Stock symbol of the company.

stock_exchange
enum

Stock exchange where your company is listed.

Allowed values: NASDAQ, NYSE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX,JPX, JSE, KRX,LON, NSE, OMX, SEHK, SGX, SSE, STO, SWX, SZSE, TSX, TWSE, VSE, OTHER

alt_business_id
string

Alternate business identification number.

alt_business_id_type
enum

Alternate business ID type.

Allowed values: DUNS,LEI, GIIN, NONE

website
string

Website of the business.

plivo_subaccount
string

Subaccount mapped to the profile.

​
Create a profile — individuals

If you use the Create a Profile API and specify entity_type=INDIVIDUAL you can skip fields like ein, ein_issuing_country, stock_symbol, stock_exchange, alt_business_id, and alt_business_id_type.

​
Returns

api_id for the request, unique profile_uuid, and success message

​
Response

HTTP Status Code: 200 
import sys
sys.path.append("../plivo-python")
import plivo

client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.profile.create(
    profile_alias="profile name sample",
    customer_type="DIRECT",
    entity_type="PRIVATE",
    company_name="ABC Inc.",
    ein="123456789",
    ein_issuing_country="US",
    stock_symbol="ABC",
    stock_exchange="NSE",
    website="www.example.com",
    vertical="REAL_ESTATE",
    alt_business_id="",
    alt_business_id_type="NONE",
    plivo_subaccount="",
    address={
        "street": "123",
        "city": "New York",
        "state": "NY",
         "postal_code": "10001",
        "country": "US"
    },
    authorized_contact={
        "first_name": "john",
        "last_name": "con",
        "phone": "1876865565",
        "email": "xyz@plivo.com",
        "title": "Mr",
        "seniority": "admin"
    },
)
print(response)

{
    "api_id": "4e1f954c-baf3-11ec-bafe-0242ac110003",
    "message": "Profile created successfully.",
    "profile_uuid": "f19c4773-4ae6-4b75-92ea-9cf3ea4227d6"
}