This section describes the various categories of the API endpoints and provides a workflow sequence for how these endpoints are typically used within the EPR Partner API. Each category is broken down into specific processes or actions.
Authentication
Authentication endpoints secure a token necessary for authorizing subsequent API calls. Refer to Authentication and Partner Configuration for proper steps for authentication to EPR.
This category covers all endpoints related to project management, from creation to managing associated details like addresses and contacts.
Project Creation
Details the steps and necessary parameters to create a new project within the EPR system.
Manage Addresses
Explains how to add or update addresses associated with a project.
Manage Contacts
Outlines how to add or modify contacts related to a project.
Documents
Endpoints under this category deal with document management within projects, including uploading and processing documents.
Upload Document
Covers the process for uploading documents to a specific project.
Document Intake
Describes the optional process of document intake following upload, if applicable.
Assignment Management
This section includes endpoints involved in managing assignments for documents within projects, facilitating the review and approval processes.
Create Assignment
Details on how to create and assign a document for review to specific users or groups.
Update Assignment
Instructions on updating the details or status of an existing assignment.
Deliverables
This section focuses on retrieving system outputs, such as comments and reports related to project documents and final deliverables.
Comment Retrieval
Describes how to retrieve comments made on documents within a project.
Generate Comment Reports
Outlines the process to generate detailed reports based on comments.
Deliverable Retrieval
Details the endpoints for retrieving final deliverables such as completed documents or project summaries.