Partner API v1

Get metadata for a content.

This resource allows to get complete metadata information for a particular content. <aside class="notice"> Depending on the content_type for each parts of the content, Kivra will return either a key to a binary file to be retrieved or (for text based contents) the body of the content itself. </aside>

get/v1/partner/company/{companyKey}/content/{contentKey}

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v1/partner/company/{companyKey}/content/{contentKey}
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

companyKeystring required

Company's unique key

The unique key for the company object being retrieved

contentKeystring required

Content's unique key

The unique key for a specific content

Response

Complete metadata for the specific content

senderstring

Unique key for the tenant that posted the content

sender_namestring

Name of the tenant that posted the content

created_atstring

Date and time when the content was delivered to the recipient

subjectstring

Subject of the content, as set by the sender

receiver_namestring

Name of the company that received the content

Example response

{
  "sender": "1341573157b3a133f220f4217b2e32989d2efa015",
  "sender_name": "Kivra",
  "created_at": "2018-06-19T11:54:10Z",
  "subject": "Invoice 4512 from Local Bank",
  "receiver_name": "Digital Hero AB",
  "payment": {
    "currency": "SEK",
    "due_date": "2017-01-01",
    "total_owed": "123.50",
    "type": "SE_OCR",
    "method": "1",
    "account": "12345",
    "reference": "426523791",
    "min_amount": "50.00"
  },
  "parts": [
    {
      "content_type": "application/pdf",
      "checksum": "9209c7eebdd283a4c4bd7555e73e6064",
      "sha256": "287f2fe67a8a76a10169aa6a885d21e1f83416c4831294ea5c4b0a38bda5c78d",
      "size": 163414,
      "body": "<!doctype html>\n<html class=\"....",
      "key": "15118724482475bf32615b4a2aaa604fd66377010e"
    }
  ]
}

Changes

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