Partner API v3

List accessible companies

List the companies the client has access to

get/v3/partner/company

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v3/partner/company
  • Auth: none declared

Query parameters

fieldFieldQueryParameter[] 
[
  "key"
]
vat_numberVatNumber[] 
[
  "SE556000475501"
]

Response

If vat_number is given, the repsonse will only include companies with VAT numbers in that list. The field parameter controls which columns (CSV) or properties (JSON) to include in the response.

keystring

The key for a company

namestring

The name of a company

type'company' | 'riksidrottsförening'

The company's/organisation's type

This is currently based on the registry holding the signatory information. Thus company really means that Bolagsverket is the registry and includes Ekonomiska föreningar as well. For riksidrottsförening it is Riksindrottsförbundet.

vat_numberstring

A Swedish VAT number ("momsregistreringsnummer").

Example response

{
  "key": "156077433683911cdca5fd4563bded979572454cb9",
  "name": "Cornelias Café AB",
  "type": "company",
  "vat_number": "SE556000475501"
}

Changes

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