Skip to main content
POST
Create a business account

Body

Request schema for the Leadping API business profile request, including the fields clients can send.

name
string
required

The display name for the entity.

Maximum string length: 255
secondaryName
string | null

Alternate business name or DBA shown in Leadping.

status
enum<string> | null

Defines the supported Business Status values.

Available options:
SettingUp,
SetupCompleted,
Active
enabled
boolean | null

Indicates whether this business profile request is active and available in the Leadping API.

autoRefillEnabled
boolean | null

Indicates whether automatic wallet refill is enabled for the business.

autoRefillAmount
string<double> | null

Wallet refill amount charged when automatic refill is triggered.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
autoRefillTrigger
string<double> | null

Wallet balance threshold that triggers automatic refill.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
phone
string | null

Phone details for the lead, user, or business represented by this business profile request.

address
object | null

Postal address for the business, lead, or contact represented by this business profile request.

billingName
string | null

Name used for invoices, receipts, and payment processor billing records.

billingAddress
object | null

Postal address used for invoices, receipts, and payment processor billing records.

billingTaxId
string | null

Tax identifier printed on billing documents. This may differ from the business verification EIN.

website
string | null

Business website URL used for compliance, brand review, and lead attribution.

vertical
string | null

Industry vertical used for lead routing, compliance review, and reporting.

description
string | null

Human-readable description that explains this business profile request to API users.

ein
string | null

Employer Identification Number used for business and 10DLC verification.

isYoungerThan90
boolean | null

Indicates whether the business serves customers younger than 90, for compliance and underwriting context.

einDocument
object | null

Uploaded EIN document reference used for business verification.

phones
object[] | null

Phone numbers assigned to this business.

compliancePolicy
object | null

Compliance policy configuration for the business.

id
string | null

The unique identifier for the entity, when updating an existing entity.

Response

Created

Response schema for the Leadping API business profile response returned to authenticated clients.

secondaryName
string | null

Alternate business name or DBA shown in Leadping.

user
object | null

User summary connected to this business profile response.

accountBalance
string<double>

Current wallet balance available to the business.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
billingPlan
enum<string> | null

Defines the supported Billing Plan values.

Available options:
Annual,
Monthly
subscriptionStatus
enum<string> | null

Defines the supported Subscription Status values.

Available options:
Pending,
Active,
Overdue,
Canceled
billingState
object | null

Customer-safe billing state for this business.

autoRefillEnabled
boolean

Indicates whether automatic wallet refill is enabled for the business.

autoRefillAmount
string<double> | null

Wallet refill amount charged when automatic refill is triggered.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
autoRefillTrigger
string<double> | null

Wallet balance threshold that triggers automatic refill.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
status
enum<string> | null

Defines the supported Business Status values.

Available options:
SettingUp,
SetupCompleted,
Active
setupStatus
enum<string> | null

Defines the supported User Setup Status values.

Available options:
Personal,
Business,
Details,
Compliance,
Phone,
Plan,
Billing,
Review,
Complete
enabled
boolean

Indicates whether this business profile response is active and available in the Leadping API.

phone
string | null

Phone details for the lead, user, or business represented by this business profile response.

website
string | null

Business website URL used for compliance, brand review, and lead attribution.

address
object | null

Postal address for the business, lead, or contact represented by this business profile response.

billingName
string | null

Name used for invoices, receipts, and payment processor billing records.

billingAddress
object | null

Postal address used for invoices, receipts, and payment processor billing records.

billingTaxId
string | null

Tax identifier printed on billing documents. This may differ from the business verification EIN.

vertical
string | null

Industry vertical used for lead routing, compliance review, and reporting.

description
string | null

Human-readable description that explains this business profile response to API users.

ein
string | null

Employer Identification Number used for business and 10DLC verification.

einDocument
object | null

Uploaded EIN document reference used for business verification.

domain
string | null

Domain name connected to the business website or activation workflow.

phones
object[] | null

Phone numbers assigned to this business.

site
object | null

Leadping website record connected to this business.

setupStep
enum<string> | null

Defines the supported Business Setup Step values.

Available options:
DomainFinding,
DomainOptionsFound,
SiteGenerating,
SiteGenerated,
BrandSubmitted,
BrandApproved,
CampaignSubmitted,
CampaignApproved,
CarrierReviewing,
TenDlcComplete,
Complete
activation
object | null

Business activation state covering site, billing, compliance, and telephony readiness.

compliancePolicy
object | null

Compliance policy configuration for the business.

name
string

The display name for the entity.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.