Access Generated Tax Packs

🔍 1. Checking the Status of the Request

To monitor the progress of your tax pack generation, you'll need to check the job status using the notifications endpoint.

💡

Note: Tax pack generation is an asynchronous process. For detailed information on checking job status, see Checking Job Status via Notifications.

Quick Reference:

Use the correlationGuid that was returned when you submitted the tax pack generation request:

GET /notifications/{correlationGuid}

Example:

https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixApi/notifications/1c92781b-1d1c-4706-8a2e-d86dc21e1896

Once the requestStatus changes to Processed, your tax pack is ready for download.

📦 2. Downloading Generated Tax Pack

To download tax pack files, use the following API endpoint with the correlationGuid from the initial generation response:

https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixApi/taxpacks/1c92781b-1d1c-4706-8a2e-d86dc21e1896

🛠️ Steps using Postman

1. Change the HTTP verb from POST to GET

2. Click on the Authorization tab and paste the previously generated API access token as the Bearer Token

   To learn how to obtain an authorization token, see Obtaining an Access Token

3. Specify the URL to /taxpacks/{correlationGuid} API endpoint. For example: https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixApi/taxpacks/1c92781b-1d1c-4706-8a2e-d86dc21e1896

▶️ Sending the Request

Click the Send button to submit the prepared request.

📄 The Response Format

The API returns the tax pack file(s) linked to the specified correlationGuid.

Default Download (All Addresses):

• A ZIP file containing all tax pack PDFs for each address associated with the client
• File name format: {correlationGuid}.zip
• Each PDF inside the ZIP follows the configured naming convention (without the GUID prefix)

Example ZIP Contents:

1c92781b-1d1c-4706-8a2e-d86dc21e1896.zip
├── TaxRep_12345_2026_1.pdf
├── TaxRep_12346_2026_2.pdf
└── TaxRep_12347_2026_3.pdf

🏢 3. Downloading Tax Pack for Specific Address (Optional)

If you need to download the tax pack for a specific address only, you can append the addressGuid as a query parameter to the download endpoint.

https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixApi/taxpacks/1c92781b-1d1c-4706-8a2e-d86dc21e1896?addressGuid=3fa85f64-5717-4562-b3fc-2c963f66afa6

🛠️ Steps using Postman

1. Change the HTTP verb from POST to GET
2. Click on the Authorization tab and paste the previously generated API access token as the Bearer Token
3. Specify the URL to /taxpacks/{correlationGuid}?addressGuid={addressGuid} API endpoint. For example: https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixApi/taxpacks/1c92781b-1d1c-4706-8a2e-d86dc21e1896?addressGuid=3fa85f64-5717-4562-b3fc-2c963f66afa6

▶️ Sending the Request

Click the Send button to submit the prepared request.

📄 The Response Format

When requesting a specific address:

• A single PDF file for the specified address
• File name follows the configured naming convention (without the GUID prefix)
• Content-Type: application/pdf

Example:

TaxRep_12345_2026_1.pdf

📘

Tax Pack Expiry

By default, tax packs are valid for 48 hours after generation and are automatically deleted once this period expires. Ensure you download your tax packs within this time