Oyster API updates - 15 September 2026

about 3 hours ago

v0.1 Agreements API updates, v0.1 Documents updates, v0.1 Time Off API updates, v1 Consents API release, v1 Documents API updates, v1 Identity Verification API release

v0.1 API updates

v0.1 Agreements API updates

Release includes: field restrictedActivities in Manage Restrictive Covenant Agreement

v0.1 Documents API updates

Release includes: field type in Retrieve documents for engagement, Retrieve individual document for engagement, Retrieve payslips for engagement, Retrieve document requests for an engagement, Retrieve a document request for an engagement, Get a document from the onboarding form; object payPeriod in Retrieve payslips for engagement;

v0.1 Time Off API updates

Release includes: query param engagement_ids[] in Retrieve all requests

v1 API updates

v1 Consents API release

Release includes: Create consent grant

v1 Documents API updates

Release includes: field type in Retrieve documents for engagement, Retrieve payslips for engagement, Get a document from the onboarding form

v1 Identity Verification API release

Release includes: Retrieve the latest identity verification for an engagement, Submit an approved partner identity verification, Submit a declined partner identity verification, Create or resume a verification session