Latest Legacy

Create a profile

This API lets you create a business profile for your customers who do not have an EIN.

API Endpoint

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

Arguments

profile_aliasstringrequired

A friendly name for your profile.

customer_typestringrequired

Indicates the nature of your operations.
Use DIRECT for starter registration.

entity_typestringrequired

Indicates ownership of the company.
Use INDIVIDUAL for starter registration.

company_namestringrequired

Legal name of the company.

vertical stringrequired

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

address objectrequired

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 objectrequired

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.
website string

Website of the business.

plivo_subaccount string

Subaccount mapped to the profile.

Response

{
   "api_id": "cc3a6dca-64a9-11ed-a9a3-0242ac110002",
   "message": "Profile created successfully.",
   "profile_uuid": "7b8ff904-a1d2-46b2-888d-34d4df4cf95a"
}

1
2
3
4
5
6
7
8
9
10
11
12

let plivo = require('plivo');
let fs = require('fs');
var authorized_contact = {"first_name":"John", "last_name":"Doe", "email":”xxxx@gmail.com", "title":"Mr", "seniority":"Admin", "phone": "14845355113"}
var address = {"street":"#11, Nashville Street", "city":"Dallas", "state":"TX", "postal_code":"10001", "country":"US"}
var client = new plivo.Client("<auth_id>","<auth_token>");
client.profile.create("sample name"," ","DIRECT","INDIVIDUAL","sample company", "COMMUNICATION", "NONE", "www.samplewebsite.com", address,authorized_contact)
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

curl -i --user auth_id:auth_token \
-H "Content-Type: application/json" \
-d '{
"profile_alias": "sample name",
"customer_type": "DIRECT",
"entity_type": "INDIVIDUAL",
"company_name": "sample company",
"vertical": "COMMUNICATION",
"alt_business_id_type": "NONE",
"website": "www.samplewebsite.com",
"address": {
"street": "#11, Nashville Street",
"city": "Dallas",
"state": "TX",
"postal_code": "10001",
"country": "US"
},
"authorized_contact": {
"first_name": "John",
"last_name": "Doe",
"email": "xxxx@gmail.com",
"title": "Mr",
"seniority": "Admin",
"phone": "14845355113"
}
}'\
https://api.plivo.com/v1/Account/<auth_id>/Profile/