Tenant API - Registered letters

Get all responses

Get the responses of all registered letters that have been signed or expired. The response key can then be used to fetch the response details of each registered letter and also to delete the response.

get/v2/tenant/{tenantKey}/registered

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/registered
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique key for a tenant for whom the registered letters belong to.

Response

List of response statuses associated with registered letters that have been either signed or expired.

keystring

Response key

status'signed' | 'expired'

Status of the registered letter response.

Changes

No recorded changes to this operation across all 1 revision of this API.