Reorient Id Card

4 min

Introduction

This API documentation is for the reOrientId endpoint, which is used to reorient an image of an ID card based on its orientation. The endpoint requires a patron ID and authentication token, as well as the image URL and time-to-live (TTL) for the processed image. The endpoint returns a response with the reoriented image URL and its expiration time.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/...patronID.../utils \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"reOrientId","essentials":{"url":"......image url........","ttl":"...expiry times..."}}'

Parameter	Data Type	Required	Description
task	string	Yes	Specifies the task to be performed
essentials	object	Yes	Contains the essential parameters required to perform the task
essentials.url	string	Yes	URL of the image to be processed
essentials.ttl	integer	Yes	Expiry time for the processed image in seconds
patronID	string	Yes	Unique identifier for the patron
Access-Token	string	Yes	Authorization token for accessing the API
Accept	string	No	Specifies the media types that are acceptable for the response
Accept-Language	string	No	Specifies the preferred language for the response
content-type	string	Yes	Specifies the format of the request body

Sample Response

{
      "essentials": {
          "url": "...image url...",
          "ttl": "..time string.."
      },
      "id": "..id..",
      "patronId": "..patron id..",
      "task": "reOrientId",
      "result": {          
              "message": "successfully reoriented",
              "status": "200",
              "reOrientedCard": "..reoriented image url..."          
      }
  }

Parameter Name	Data Type	Required	Description
essentials	Object	Yes	An object containing URL and ttl for the image.
url	String	Yes	URL of the image to be reoriented.
ttl	String	Yes	Expiry time for the reoriented image.
id	String	Yes	Unique ID for the API request.
patronId	String	Yes	Unique ID for the patron.
task	String	Yes	The task for the API request.
result	Object	Yes	The object containing the API request result details.
message	String	Yes	The message indicates if the reorientation was successful.
status	String	Yes	HTTP status code of the API response.
reOrientedCard	String	Yes	URL of the reoriented image.