Create a profile
This API lets you create a business profile for your end customers.
API Endpoint
Arguments
profile_alias string required | A friendly name for your profile. |
customer_type string required | Indicates the nature of your operations. Allowed values: Select |
entity_type string required | Indicates ownership of the company. Allowed values: |
company_name string required | Legal name of the company. |
vertical string required | Indicates industry. Allowed values: |
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": ""}
|
authorized_contact object required | Authorized contact person at the company. ”first_name”: “John”, Fields 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: |
alt_business_id string | Alternate business identification number. |
alt_business_id_type enum | Alternate business ID type. Allowed values: |
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