Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

PUT /compliance/customer-profile

PUT
/api/v1/compliance/customer-profile
curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/compliance/customer-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "business_legal_name": "example", "business_registration_id_type": "EIN", "business_registration_id": "example", "industry": "AGRICULTURE", "business_type": "SOLE_PROPRIETOR", "business_website": "https://example.com", "address": { "street1": "example", "street2": "example", "city": "example", "region": "example", "postal_code": "example", "iso_country": "example" }, "authorized_rep": { "full_name": "example", "email": "hello@example.com", "phone": "example", "job_title": "example" } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
business_legal_name
required
string
>= 1 characters <= 300 characters
business_registration_id_type
required
string
Allowed values: EIN DUNS CCN CBN GIIN CIK OTHER
business_registration_id
required
string
>= 1 characters <= 50 characters
industry
required
string
Allowed values: AGRICULTURE AUTOMOTIVE BANKING CONSTRUCTION CONSUMER EDUCATION ENERGY ENGINEERING FAST_MOVING_CONSUMER_GOODS FINANCIAL FINTECH FOOD_AND_BEVERAGE GOVERNMENT HEALTHCARE HOSPITALITY INSURANCE LEGAL MANUFACTURING MEDIA NOT_FOR_PROFIT OIL_AND_GAS POLITICAL PROFESSIONAL_SERVICES REAL_ESTATE RELIGION RETAIL TECHNOLOGY TELECOMMUNICATIONS TRANSPORTATION TRAVEL
business_type
required
string
Allowed values: SOLE_PROPRIETOR PARTNERSHIP LIMITED_LIABILITY_CORPORATION CORPORATION CO_OPERATIVE NON_PROFIT_CORPORATION GOVERNMENT_ENTITY
business_website
required
string format: uri
<= 500 characters
address
required
object
street1
required
string
>= 1 characters <= 200 characters
street2
string
<= 200 characters
city
required
string
>= 1 characters <= 100 characters
region
required
string
>= 1 characters <= 100 characters
postal_code
required
string
>= 1 characters <= 20 characters
iso_country
required
string
>= 2 characters <= 2 characters
authorized_rep
required
object
full_name
required
string
>= 1 characters <= 200 characters
email
required
string format: email
<= 320 characters
phone
required
string
>= 5 characters <= 20 characters
job_title
required
string
>= 1 characters <= 100 characters

Responses

Section titled “Responses”

200

Section titled “200”

OK

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Section titled “402”

Feature not available on the organization plan

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “403”

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}