Skip to main content
POST
Create vendor

Authorizations

x-api-key
string
header
required

Body

application/json
display_name
string
required

The vendor name, as shown in the Every dashboard

Minimum string length: 1
email
string<email>
required

The vendor contact email. Also where the W9 onboarding link is sent when w9 is omitted.

w9
object

The vendor's W9 details. Supplying them completes the vendor's onboarding at once; omitting them emails the vendor a link to fill in the same details itself.

Response

The vendor created

A single vendor, with the W9 details it was created or updated with. The list omits them: a taxpayer id is not something to hand out a page at a time, and even here tax_ein is masked.

id
string<uuid>
required
company_id
string<uuid>
required
display_name
string
required

The vendor name, as shown in the Every dashboard

w9_complete
boolean
required

Whether the vendor's W9 details are on file. False while the vendor still has an onboarding form to fill in, whether it was asked through this API or in the Every dashboard.

w9
object
required

The stored W9 details, in the shape w9 is written in, so they can be read, completed and sent back. Null fields are the ones the vendor has not provided. tax_ein is the one field that does not round-trip: it is served masked, and an update that sends the mask back is refused.

email
string | null

The vendor contact email

created_at
string<date> | null

The date the vendor was created