Partner API v1

Lookup a specific company

This resource allows a partner to look if a specific company has granted access to its mailbox.

<aside class="notice"> If a search is done and the Company doesn’t exist in Kivra or has not granted access to the partner, an empty list will be returned. </aside>
get/v1/partner/company

Request

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

Query parameters

vat_numberstring required

Company's unique VAT number

Example:SE556840226601

Perform a search to see if a specific Company is available for access

Response

Company key for the company with the matching VAT number

keystring

Company's unique Key

Example response

{
  "key": "15236156848eefa1dc75364af2be38c98eb3aae223"
}

Changes

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