Skip to main content
POST
Update a business

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
user_id
string
required

Identifier of the target user. Required when the endpoint operates on a specific user.

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

business_id
string
required

Identifier of the target business. Required when the endpoint operates on a specific business.

Example:

"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"

api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

email
string<email>

Email address.

Example:

"jane.doe@example.com"

business_email
string

Business onboarding field: business email.

business_phone
string

Business onboarding field: business phone.

business_phone_number
string

Business onboarding field: business phone number.

phone_number
string

Phone number in E.164 format.

Example:

"+12125551234"

support_email
string

Business onboarding field: support email.

support_phone_number
string

Business onboarding field: support phone number.

website
string

Business onboarding field: website.

business_address
string

Business onboarding field: business address.

business_address_2
string

Business onboarding field: business address 2.

naics_code
string

Business onboarding field: naics code.

business_type
string

Business onboarding field: business type.

business_industry
string

Business onboarding field: business industry.

country
string

ISO 3166-1 alpha-2 country code.

state
string

ISO 3166-2 two-letter state/region code.

city
string

City.

zipcode
string

5-digit US ZIP code.

business_description
string

Business onboarding field: business description.

incorporated_date
string

Business onboarding field: incorporated date.

incorporated_state
string

Business onboarding field: incorporated state.

ein
string

Business onboarding field: ein.

business_rep_name
string

Legal name of the business representative.

business_rep_email
string

Business onboarding field: business rep email.

business_rep_job_title
string

Business onboarding field: business rep job title.

business_rep_dob
string

Business onboarding field: business rep dob.

business_rep_address
string

Business onboarding field: business rep address.

business_rep_address_2
string

Business onboarding field: business rep address 2.

business_rep_zipcode
string

Business onboarding field: business rep zipcode.

business_rep_city
string

Business onboarding field: business rep city.

business_rep_phone
string

Business onboarding field: business rep phone.

business_rep_ssn
string

Business onboarding field: business rep ssn.

business_rep_website
string

Business onboarding field: business rep website.

business_rep_country
string

Business onboarding field: business rep country.

business_rep_state
string

Business onboarding field: business rep state.

support_address_one
string

Business onboarding field: support address one.

support_address_two
string

Business onboarding field: support address two.

support_country
string

Business onboarding field: support country.

support_city
string

Business onboarding field: support city.

support_zipcode
string

Business onboarding field: support zipcode.

support_state
string

Business onboarding field: support state.

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.