Onboards New Limited Partner

POST 
https://api.verticalinsure.com/v1/partners/onboard

Onboards a new limited partner

Request

application/json

Bodyrequired

entity_name stringrequired
Partner entity name
administrative_email_address emailrequired
Administrative contact email address
billing_email_address email
Billing contact email address
address string
Street address
city string
City
state string
State code
postal_code string
Postal code
travel_retailer boolean
If true, the partner will be emailed with steps to become a certified travel retailer.
country Country (string)required
2-character country code
Possible values: [US, CA]
Example: US
website stringrequired
Website
bank_account object
banking info
ach_account_number string
ach_routing_number string
ach_account_type ACHAccountType (string)
Possible values: [CHECKING, SAVINGS]
ach_account_name string
eft_bank_code string

Responses

201

onboard-limited-partner 201 response

application/json

Schema

Schema

id uuid
Partner id
status PartnerStatus (string)
Partner status
Possible values: [ACTIVE, PENDING_CONFIGURATION, PENDING_ONBOARDING, INACTIVE]
type PartnerType (string)
Partner type
Possible values: [STANDARD, LIMITED]
entity_name stringrequired
Partner entity name
administrative_email_address emailrequired
Administrative contact email address
billing_email_address email
Billing contact email address
address string
Street address
city string
City
state string
State code
postal_code string
Postal code
country Country (string)required
2-character country code
Possible values: [US, CA]
Default value: US
Example: US
website stringrequired
Website
travel_retailer_onboarding_url string
URL returned to complete onboarding as a travel retailer. Only returned if travel_retailer = true
travel_retailer_onboarding_complete booleanrequired

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "ACTIVE",
  "type": "STANDARD",
  "entity_name": "string",
  "administrative_email_address": "user@example.com",
  "billing_email_address": "user@example.com",
  "address": "string",
  "city": "string",
  "state": "string",
  "postal_code": "string",
  "country": "US",
  "website": "string",
  "travel_retailer_onboarding_url": "string",
  "travel_retailer_onboarding_complete": true
}

Authorization: http

name: basic authtype: httpdescription: `Authorization` header with value of `Basic <auth string>` where the `auth string` value
is a base64 encoded string of `<client id>:<client secret>`
scheme: basic

• curl
• python
• nodejs
• ruby
• php

• CURL

curl -L 'https://api.verticalinsure.com/v1/partners/onboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "entity_name": "string",
  "administrative_email_address": "user@example.com",
  "billing_email_address": "user@example.com",
  "address": "string",
  "city": "string",
  "state": "string",
  "postal_code": "string",
  "travel_retailer": true,
  "country": "US",
  "website": "string",
  "bank_account": {
    "ach_account_number": "string",
    "ach_routing_number": "string",
    "ach_account_type": "CHECKING",
    "ach_account_name": "string",
    "eft_bank_code": "string"
  }
}'

Request Collapse all

Base URL

https://api.verticalinsure.com

Auth

Username

Password

Body required

{
  "entity_name": "string",
  "administrative_email_address": "user@example.com",
  "billing_email_address": "user@example.com",
  "address": "string",
  "city": "string",
  "state": "string",
  "postal_code": "string",
  "travel_retailer": true,
  "country": "US",
  "website": "string",
  "bank_account": {
    "ach_account_number": "string",
    "ach_routing_number": "string",
    "ach_account_type": "CHECKING",
    "ach_account_name": "string",
    "eft_bank_code": "string"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!