Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json
phone
string
required

The consumer number; normalized to E.164.

signatureType
enum<string>
required

web_form is A6-gated on the org approved disclosure; imported_attested is A3-validated.

Available options:
web_form,
imported_attested
contactId
string

pewc (default) | express

audienceType
string

consumer (default) | business

sellerName
string

PEWC element (c); a web_form record falls back to the org seller name.

disclosureText
string

Verbatim consent wording. Required (and AI-voice-authorizing) for imported_attested.

source
string

hosted_form | tenant_form | csv_import | api (default api).

sourceContext
string

URL / IP / form id (provenance).

evidenceUrl
string
capturedAt
string

RFC3339 consent timestamp; stored as signedAt (the consent date).

signedAt
string

RFC3339 signature date; preferred over capturedAt.

expiresAt
string

RFC3339 optional consent expiry.

Response

The recorded consent proof.

success
boolean
required
data
object
required
message
string
errors
object[]