Skip to main content
POST
Execute the BAA by typed e-signature

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
signer_name
string
required

Full legal name of the owner signing the agreement.

Required string length: 2 - 200
Example:

"Jordan Reyes"

signer_email
string
required

Email address of the signer, recorded with the signature.

Maximum string length: 320
Example:

"jordan@acmehealth.example"

typed_attestation
string
required

The attestation sentence exactly as prompted on the signing screen.

Required string length: 2 - 200
Example:

"I agree to the Business Associate Agreement"

template_version
string

Optional template revision to sign; omit to sign the current version.

Required string length: 1 - 20
Example:

"v1"

Response

Successful response.