This document 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.
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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.
...
| Code Block |
|---|
{
"project_id": "123",
"filename": "my_document.pdf",
"vendor_id": "456",
"filePath": "tmp/documents/1706565016288/my_document.pdf"
}
|
Note: All files uploaded to the uploadDocument API will be processed with the PDFScout Inspector tool. You should have PDFScout as part of your Applicant Portal to allow documents to be validated to avoid upload errors. Error handling for Scout failures is very similar in logic, with the payload varying slightly when uploading via uploadDocument API. For more details, please see
PDFScout Inspector Partner Integration DocumentationAttachment Upload Process
...
Retrieve Configuration Data:
Fetch list types and corresponding list items to populate fields like
contactType.
Document Upload:
Obtain a pre-signed URL for the document.
Upload the document to S3 using the pre-signed URL.
Confirm the upload using the
POST /partner/uploadDocumentendpoint.
Attachment Upload:
Obtain a pre-signed URL for the attachment.
Upload the attachment to S3 using the pre-signed URL.
Confirm the upload using the
POST /partner/projectAttachmentsendpoint.
Step 6: Document Intake, Document Versioning and Assignment Management
MVP Scope:
Document intake, document versioning, and assignment management are critical processes that the end user will handle manually during the MVP phase. This approach ensures the essential functionality is validated and approved before automating these processes.
...
Step 7: Deliverables
This section explains how to handle deliverables within the EPR system during the MVP phase. Deliverables typically include documents, attachments, and comment reports. Users can retrieve these items individually or as a ZIP package.
...