Tenant API - Agreements

Get the covenant file (signed agreement)

Get the covenant file (the signed version of the agreement).

get/v1/tenant/{tenantKey}/agreement/{agreementKey}/covenant

Request

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

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant

agreementKeystring hexadecimal required

The unique Key for an Agreement

Response

The covenant file as a PDF file with base64 encoding

namestring

The name of the file

datastring base64

The covenant file as a PDF file with base64 encoding

sha256string

the signature to verify the file's authenticity

Example response

{
  "name": "agreement7456_completed.pdf",
  "data": "REVBREJFRUY="
}

Changes

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