Skip to main content
POST
Get a recipient's signing URL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

The workspace the key was issued for, as returned by GET /api/v1/workspaces. Optional: omitting it acts in the key's workspace, and any other id is rejected with 401.

Path Parameters

packageId
string
required

Body

application/json
recipientId
string

The id of one of the package's recipients, as listed on GET /api/v1/packages/:packageId. Give this or recipientEmail, not both.

Minimum string length: 1
Example:

"cmg4v8q2k0002s7xh6k4m1p9c"

recipientEmail
string<email>

The email address of one of the package's recipients, matched ignoring case. An address two recipients share is a 409, so use recipientId then.

Example:

"jane.ahu@example.co.nz"

Response

Success

data
object
required