Save Booking Document API

Save Booking Document API Endpoint
StoRegister - Login

Store Client Signature for Future Move-In

This endpoint enables the storage of the client's signature in temporary memory for subsequent move-in processing. It proves particularly useful after the successful completion of the payment process. It's essential to note that the client signature will be permanently deleted upon the successful move-in or within one day, as part of compliance with data protection regulations. This practice ensures that no personal information is retained on the server for an extended period.

POST
/v1/booking/{bookingId}/document/save
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

URL Query Parameters:

  • bookingId unique-identifier required

    bookingId refers to an activity ID of the specific booking.

Request Body:

  • signature string required

    Base64-encoded representation of the client's signature.

Response Payload:

  • succeeded boolean

    Indicates whether the request to store the client's signature for future move-in was successful.

  • status string

    Describes the status of the request (e.g., "SUCCESS").

  • data object

    Contains information about the saved client signature activity.

  • errors null

    Holds error information if applicable. It is null for successful requests.

Request Header

Authorization: X-API-Key --api-key--

API Request

{
    "signature": "iVBORw0KGgoAAAANSUhEUgAAASAAAABwCAYAAAC+eq3DAAAAAXNSR0IArs4c..."
}

API Response

{
    "data": "4AF3E793-9BF1-4BB5-B555-B19861A86437",
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_SIGNATURE

    INVALID_PARAM_SIGNATURE refers to invalid signature.

  • INVALID_PARAM_ACTIVITY_INFO_ID

    INVALID_PARAM_ACTIVITY_INFO_ID refers to invalid booking(activity) ID.

  • INVALID_ACTIVITY_INFO_DETAILS

    INVALID_ACTIVITY_INFO_DETAILS refers to invalid activity details.

  • INVALID_DOCUMENT_TYPE_RESPONSE

    INVALID_DOCUMENT_TYPE_RESPONSE refers to invalid document type.

  • INVALID_CLIENT_INFO_DETAILS

    INVALID_CLIENT_INFO_DETAILS refers to invalid client details.

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation