Lookup a specific company

GET

/v1/partner/company

const url = 'https://sender.api.kivra.com/v1/partner/company?vat_number=SE556840226601';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://sender.api.kivra.com/v1/partner/company?vat_number=SE556840226601' \
  --header 'Authorization: Bearer <token>'

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

Note: 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.

Authorizations

oAuth2Client
get:kivra.v1.partner.company

Parameters

Query Parameters

vat_number

required

Company’s unique VAT number

string

Example

SE556840226601

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

Responses

200

Company key for the company with the matching VAT number

application/json

object

key

Company’s unique Key

string

Example

{
  "key": "15236156848eefa1dc75364af2be38c98eb3aae223"
}