We plan on making the following breaking changes on the dates mentioned:

Jan 2, 2024

The PATCH request method will be removed from the following endpoints:

/api/v1/staff/service-requests
/api/v1/staff/service-requests/{id}

We do not expect that these changes will require migration as this functionality is currently unused.

March 1, 2024

To improve security we will be enforcing 24 hour time limited links to file content across all file objects returned in our API. Specifically, the content and secure_content fields returned within the listed file objects in each listed API will be deprecated and replaced with a time_limited_url field:

/api/v1/org/board-certificates
    document
/api/v1/org/board-certificates/{id}
    document
/api/v1/org/cme-credits
    document
/api/v1/org/cme-credits/{id}
    document
/api/v1/org/licenses
    document
    loq_document
/api/v1/org/licenses/{id}
    document
    loq_document
    files - Note: This is a list field. Each object in the list will have content and secure_content fields
/api/v1/org/practices
    accreditation
    medicare_notices_of_approval
    medicaid_notices_of_approval
/api/v1/org/practices/{id}
    accreditation
    medicare_notices_of_approval
    medicaid_notices_of_approval
/api/v1/org/providers/{provider_pk}
    dea_waiver
    loq_document
/api/v1/org/providers/{provider_pk}/additional-names
    document
/api/v1/org/providers/{provider_pk}/additional-names/{id}
    document
/api/v1/org/providers/{provider_pk}/exams/
    document
/api/v1/org/providers/{provider_pk}/exams/{id}
    document
/api/v1/org/providers/{provider_pk}/medical-programs
    ecfmg_certificate
/api/v1/org/providers/{provider_pk}/medical-programs/{id}
    ecfmg_certificate
/api/v1/org/providers/{provider_pk}/supervisors
    document
/api/v1/org/providers/{provider_pk}/supervisors/{id}
    document
/api/v1/org/providers/{provider_pk}/collaborative-agreements
    document
/api/v1/org/providers/{provider_pk}/collaborative-agreements/{id}
    document
/p/api/v1/organizations/{organization_id}/primary-source-verifications
    confirmation.signature
    evidences.document - Note: evidences is a list field. Each evidence includes a document object which will have a secure_content field

We have released the time_limited_url field to allow for migration and testing over the next few months. If you are storing or downloading the deprecated fields in your integration you will need to make updates to access the new time_limited_url field instead and download your file content within 24 hours.

We will also be changing our document content endpoint. The following endpoint will be deprecated:

/p/api/v1/documents/{id}/content/

and replaced with:

/p/api/v1/documents/{id} which returns a document object with the following structure:
    id: UUID
    title: str
    time_limited_url: str - URL which can be used to download the file contents within 24 hours

If you are using the deprecated document content API in your integration you will need to update to access the document id API instead and download content from the time_limited_url within 24 hours.