SureTax Returns API

GET Form Instance URL

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint facilitates the retrieval of a URL that enables users to view or edit a specific form instance within the client UI. The URL generated by this endpoint grants direct access to the form instance, providing users with the ability to either view or modify its contents as needed. The URL includes authentication-related data required for secure access and has an expiration time to ensure security measures.

OperationId: GET Form Instance URL

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/FormInstanceURL

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string
Action*	Action	string

*Mandatory parameter

FormInstanceURLResponse

OVERVIEWEXAMPLE

Overview

FormInstanceURLResponse

Display Name	Field Name	Field Type
Data	data	object

Example Response

{
  "data": {
    "url": "https://sandboxsuretaxapp.taxrating.net?sessionId=9888acf0-1795-4876-8292-a3d6bc5dd4dc\u0026action=Edit"
  }
}

Response Codes

code	description
201	The API response contains the URL for the specified form instance. Success Response - 201 Created.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. Invalid parameters or missing required information.
401	Unauthorized access. The request requires user authentication.
500	Internal server error. An error occurred while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstanceURL

Add Request Headers: