List available recipient companies for a tenant

GET

/v1/tenant/{tenantKey}/company

const url = 'https://sender.api.kivra.com/v1/tenant/example/company?vat_number=SE556000475501';
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/tenant/example/company?vat_number=SE556000475501' \
  --header 'Authorization: Bearer <token>'

This resource is used to list all, or search for specific, Companies that are eligible for receiving Content from the specific Tenant. The response is a JSON list of Objects containing the eligible Companies’ VAT number.

A search is done by providing the vat_number query parameter. If a search is done and the Company does not exist or have opted out of receiving Content from the Tenant an empty list will be returned.

Authorizations

oAuth2Client
get:kivra.v1.tenant.{tenantKey}.company

Parameters

Path Parameters

tenantKey

required

string format: hexadecimal

The unique Key for a Tenant.

Query Parameters

vat_number

VatNumber

A Swedish VAT number (“momsregistreringsnummer”).

string

/^SE[0-9]{10}01$/

Example

SE556000475501

Perform a search to see if a VAT number matches an eligible Company Recipient of the Tenant.

Responses

200

List of Companies’ keys and VAT numbers which are eligible Recipients of the Tenant.

application/json

Array<object>

CompanyList

object

key

This value is deprecated and will always be set to the empty string.

string

Allowed values: ""

vatnr

VatNumber

A Swedish VAT number (“momsregistreringsnummer”).

string

/^SE[0-9]{10}01$/

Example

[
  {
    "key": "",
    "vatnr": "SE556000475501"
  }
]