Privyde Developers

Deprecation and sunset policy

The Privyde public API is versioned in the URL path. /api/v1/... is the address to integrate against, and the unversioned /api/... form is an alias of the current version. Every response carries an API-Version header, so a client always knows what answered it.

What can change without notice

• New endpoints.
• New optional request fields.
• New fields in a response object. Clients must ignore fields they do not know.
• New enum members in fields documented as extensible.

What counts as breaking

• Removing or renaming an endpoint, a field or an enum member.
• Changing the type or the meaning of an existing field.
• Making an optional request field required.
• Changing the status code or the error code returned for an existing condition.

A breaking change ships as a new path version (/api/v2/). The previous version keeps answering while it is supported.

How a retirement is announced

When a version or an endpoint is scheduled for removal, every one of its responses starts carrying these headers. A client that reads them finds out on its next ordinary call: no newsletter, no blog post, nothing a machine can miss.

Deprecation: @1774051200
Sunset: Sat, 20 Jun 2026 00:00:00 GMT
Link: <https://privyde.com/developers/deprecation>; rel="deprecation"; type="text/html"
API-Version: 1

• Deprecation (RFC 9745): when the decision took effect. The endpoint still works.
• Sunset (RFC 8594): the date it stops answering.
• Link; rel="deprecation": this page, with what to migrate to.

Notice period

At least 180 days between Deprecation and Sunset. The only exception is a change forced by a security or legal obligation, which is announced with as much notice as the obligation allows and explained on this page.

Currently deprecated

Nothing. v1 is the current and only version, and no endpoint is scheduled for removal. This section is where retirements are listed, with their sunset date, while they are in progress.

← Back to the developer portal·info@privyde.com