GET FormInstanceDownloadURL

Description

This API endpoint provides clients with the download URL for accessing a specific form instance. A unique URL is generated for restricted access. The URL includes necessary authentication data, ensuring secure access to the form instance and contains expiration time to enhance security.

ALT

Endpoint

• Endpoint: <environment base url>/v1.0/api/Forms/FormInstanceDownloadURL

• Method: GET

Request Parameters

Parameter Type Required Multiple values
id String (max length 32) Yes Yes, comma-separated

Response Structure

{
  "data": {
    "url": [
      {
        "id": "String",
        "downloadUrl": "String"
      }
    ]
  }
} `

API Contract

  • id: Max length 32, ID of the generated form instance.

Additional Notes

  • Response contains the URL for each form instance ID passed in the request using which the browser can download the content.
  • downloadUrl includes any authentication-related data like tokens and others so that the client does not need to authenticate again to download the content.
  • downloadUrl contains an expiration time beyond which it is impossible to download the form using the same URL.

Sample Response

{
    "data": {
        "formInstances": [
            {
                "id": "68962b44-579b-4477-82e5-4b92ae30ce31",
                "downloadUrl": "https://sandboxsuretaxzar.taxrating.net/downloads/7330d7b3-ae00-4c9c-b332-5564280dcb09/TX_01-114_%24webSales_Mar_2024_20240312184655.pdf?sv=2021-10-04&se=2024-06-03T16%3A57%3A07Z&sr=b&sp=r&rscc=max-age%3D0&sig=Rz5lUabVrGgvdJrjj7OG1RTAHALC6SW%2B3IMAyzKf38k%3D"
            }
        ]
    }
}

Sample request [CURL]

curl --location 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/FormInstanceDownloadURL?id=3e7adb1a-0445-4cb0-8baf-0ee0791d6b62' \
--header 'Authorization: Bearer <access_token_value>' \
--data ''