Tenant API - Agreements

Agreement object with current status and updated metadata

Get an agreement with current status and updated metadata

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

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v1/tenant/{tenantKey}/agreement/{agreementKey}
  • 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

Agreement object with current status and updated metadata

subjectstring

Name of the agreement

created_atstring

The time when the agreement was created

expires_atstring

The expiration time for the agreement, if the agreement is not completed before this date, it will no longer be available for signature

state'active' | 'generating' | 'completed' | 'revoked'

The current state of the agreement

tenant_namestring

The name of the tenant that created the agreement

tenantstring

The tenant key that created the agreement

typestring

The type of agreement as provided by the sender when the agreement was created

Example response

{
  "subject": "Employment agreement",
  "created_at": "2019-04-09T13:42:26Z",
  "expires_at": "2019-05-09T13:42:26Z",
  "state": "completed",
  "tenant_name": "Sender AB",
  "tenant": "tenant_154442474745511bbaaa5b44b391eae0513e2c55a0",
  "type": "agreement",
  "signatures": [
    {
      "ssn": "197701032380",
      "real_name": "Jan-Erik Karlsson",
      "created_at": "2019-04-12T08:23:29Z",
      "order_ref": "d4ace777-6b91-4172-903e-39371ede89f1"
    },
    {
      "ssn": "198112172385",
      "real_name": "Gustav Johan Larsson",
      "created_at": "2019-04-11T18:53:03Z",
      "order_ref": "f5bce777-0b42-4222-1f3e-ab523ede7a5f"
    }
  ],
  "parties": [
    {
      "ssn": "197701032380",
      "name": "Jan-Erik Karlsson",
      "email": "je.karlsson.hem@email.nu",
      "role": "signer"
    },
    {
      "ssn": "198112172385",
      "name": "Gustav Larsson",
      "email": "gustav123@mymail.com",
      "role": "delegate"
    }
  ]
}

Changes

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