Sender API v2: plans and correspondence

The Sender API is redesigned around two primitives.

Plans are reusable workflow definitions. Correspondence is the record of anything started, one-off or from a plan. A letter, an agreement, a routed approval, a consent drive, and a form are kinds of correspondence rather than separate APIs, so participants, minutes, covenants, and exports work the same way on all of them.

Start at The model.

Breaking changes

• Credentials are organisation-scoped. The /tenants/{tenant_id} path segment is gone: your key identifies the organisation, and its prefix identifies the plane (kp_live_, kp_sandbox_). The base URL is now https://api.keepable.co/sender/v2.
• Recipient matching collapsed to one endpoint, POST /recipient-checks, which answers about one identifier and is throttled per identifier.
• Access delegation and recipient provisioning were dropped. Organisation membership and claim codes supersede them.
• The event catalogue collapsed. participant.acted replaces the kind-specific delivery, signature, and decision events; data.act narrows it.
• Pagination is cursor / next_cursor, not next / next_token.
• Delivery metrics dropped the modelled environmental-impact estimates.

New

• Tokenized send. Address somebody by a declared name with no identifier. Keepable deposits the file and mints a single-use claim code; you hand it over on your own channel, and it redeems only inside the app after NIN verification with name congruence. No links, ever.
• Sensitive answers. A question can declare itself sensitive. The answer is stored encrypted, masked on the wire by default, and unmasked only by a deliberate, minuted request under its own scope.
• Work connections. Search your directory live and pull a file from your own drive at the moment you attach it. Nothing is ever synced.
• Restricted correspondence. A file's row stays visible to the organisation while its contents go to its participants and named readers.

Migrating

Nothing is auto-migrated. The version is the /v2 in the URL and there is no header to set, so porting is a matter of reading The model and rewriting against the two primitives. Sandbox is free and usable before approval, which is where to do it.