Attention!

Looking for the most up-to-date Sales Tax Filing or CertManager documentation? Go to our new documentation platform, Sovos Docs. For Global Tax Determination, connector and CertManager API docs, stay here.

Pull image metadata

Single image

Use this request to pull the metadata for a single image in CertManager. You will need the unique image ID received in the response when creating the image.

Request information

  • HTTP method: GET
  • URL (replace imageId with the ID of the image you want to pull)
    • CertManager UAT: https://certmanager-uat.sovos.com/api/pre-auth/v1/certificates/images/imageId
    • CertManager Production: https://certmanager.sovos.com/api/pre-auth/v1/certificates/images/imageId

Example response

{
     "status": 200,
     "message": "Retrieved image metadata",
     "success": true,
     "data": {
          "id": "uuid"
          "fileName": "filename.pdf",
          "createdDate": 1741030975930,
          "pageCount": 1,
          "createdBy": "username@sovos.com",
          "priority": true //boolean, true if image was marked as priority
     }
}

Multiple images

Request information

  • HTTP method: GET
  • URL
    • CertManager UAT: https://certmanager-uat.sovos.com/api/pre-auth/v1/certificates/images
    • CertManager Production: https://certmanager.sovos.com/api/pre-auth/v1/certificates/images

Parameters for pagination

Parameter

Data type

Required or optional

Default value

Description
perPage Number Optional 50 The number of images to return per page
page Number Optional 0 The page of exemptions to return
order String Optional desc

If asc, the image list will be sorted by the sortBy value in ascending order

If desc, the image list will be sorted by the sortBy value in descending order
sortBy String Optional createdDate The field that you want to sort the image list by

Parameters for filtering

Parameter

Data type

Required or optional

Description

isPriority Boolean Optional

If true, the list will only include images marked as priority

fileName String Optional The name of the image file
createdBy String Optional The user who created the image
createdDate String Optional

Filter by createdDate to return all images created on, before, or after that date, depending on the value of createdDateIs
createdDateEndDate String Optional

Filter by createdDate and createdDateEndDate to return all images created in that date range
createdDateIs String Optional

Determines how the list is filtered by the created date

Possible values:

  • is
  • before
  • after
  • between

Example response

{
     "status": 200,
     "message": "Retrieved images metadata",
     "success": true,
     "data": {
          "items": [
               {
                    "id": "uuid",
                    "fileName": "filename.pdf",
                    "createdDate": 1741030975930,
                    "pageCount": 1,
                    "createdBy": "username@sovos.com",
                    "priority": false
               }
               ...
          ]
     },
     "pageState": {
          "page": 0,
          "perPage": 50,
          "totalPages": 1,
          "totalEntries": 3
     },
}