Tenant API - Agreements

Post an agreement to be signed

This resource is used to post an agreement to be signed by the recipients listed in the metadata. An Agreement ID will be returned. Note that the size of the agreement file cannot exceed 1MB.

post/v1/tenant/{tenantKey}/agreement

Request

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

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant

Request body

subjectstring required

Name of the agreement

typestring required

the type of content, for agreements always use 'agreement'

vat_numberstring

A valid VAT-identifier, Swedish format: SE[xxxxxxxxxx]01

expiration_daysinteger

Number of days an agreement will be available for signing, before expiring. The expiration_days must be between 7 and 180 days

Example request

{
  "subject": "Employment agreement",
  "type": "agreement",
  "vat_number": "SE556840226601",
  "expiration_days": 60,
  "original": {
    "name": "agreement1025.pdf",
    "content_type": "application/pdf",
    "data": "REVBREJFRUY="
  },
  "parties": [
    {
      "ssn": "197701032380",
      "name": "Jan-Erik Karlsson",
      "email": "je.karlsson@email.nu",
      "role": "signer"
    },
    {
      "ssn": "198112172385",
      "name": "Gustav Larsson",
      "email": "gustav123@mymail.com",
      "role": "delegate"
    }
  ]
}

Response

Agreement created succesfully

string required

Example response

"15544700816b7d63c83d6e476493879b5043ec9d7b"

Changes

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