Skip to main content
POST
Create recipient

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Headers

Idempotency-Key
string

Unique key for idempotent requests. Recommended for all write operations.

Path Parameters

company_id
string
required

Company ID.

Body

application/json

Provide worker when recipient_type is contractor or employee. Provide vendor when recipient_type is vendor.

recipient_type
enum<string>
required
Available options:
contractor,
employee,
vendor
external_id
string
worker
object
vendor
object

Response

200 - application/json

Recipient created.

recipient_id
string
recipient_type
string
relationship_id
string
status
string
idempotency_replayed
boolean