Get Data

4 min

Introduction

The provided curl is a sample command-line request for the Signzy API version 2, which allows patrons to access a range of global utility features. The curl makes a POST request to the endpoint /api/v2/patrons/..your-patron-id../globalutilities, passing a JSON payload containing the task of "getData" and essential data such as requestId. The request is authenticated with an Access-Token passed in the Authorization header. The response will be in JSON format and will contain the requested data. This API can be used to perform a variety of tasks related to global utilities, such as fetching data and generating reports. Detailed documentation on how to use this API and its various endpoints can be found in the Signzy API documentation.

Sample Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../globalutilities \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"getData","essentials":{"requestId":"...requestId..."}}'

Parameter	Description
request method	POST
URL
Accept	Header specifying the media types that are acceptable for the response. In this case, it is set to "/" to indicate that any media type is acceptable.
Accept-Language	Header specifying the preferred natural language for the response. In this case, it is set to "en-US,en;q=0.8" to indicate a preference for US English, but also indicating that any English is acceptable with a lower weight of preference.
Authorization	Header containing the access token for authentication. This token is required to access the API.
content-type	Header specifying the media type of the request payload. In this case, it is set to "application/json" to indicate that the payload is in JSON format.
task	The specific task to be performed by the API. In this case, it is set to "getData".
requestId	A unique identifier for the API request. This is an essential data required to be passed in the payload for successful execution.

Sample Response

{
	"result": {
        "requestId": "..requestId..",
        "callbackUrl": "..callbackUrl..",
        "status": "SUCCESS",
        "detail": "..detail..",
        "addressess": [
            {
                "billingAddress": "BILLING ADDR, STRING, 12346",
                "statementDate": "..date.."
            }
        ]
    }
  }

Parameter	Description
requestId	A unique identifier for the API request. This should match the requestId provided in the original API request.
callbackUrl	The callback URL to which the response will be sent asynchronously once the API has completed processing the request.
status	The status of the API request. This can be one of several possible values, such as "SUCCESS", "FAILURE", or "IN_PROGRESS".
detail	A message describing the result of the API request. This can provide additional information about the request status and any errors that may have occurred.
billingAddress	The billing address associated with the provided account. This is typically a string containing the address information, such as street, city, state, and ZIP code.
statementDate	The date of the statement associated with the provided account. This can be useful for tracking billing cycles and other account activity over time.