Tenant API - Content

Match a list of VAT numbers to recipients for a specific tenant (v2)

This resource is used to match a list of Companies to check that they are eligible for receiving Content from a specific Tenant. The request contains a list of VAT numbers to be matched, and the response is a filtered subset of said list containing only those VAT numbers matching a Company Recipient for which the Tenant is eligible to send Content to.

<aside class="notice"> If none of the provided VAT numbers match a Recipient eligible to receive content from the given Tenant, an empty list will be returned. </aside>
post/v2/tenant/{tenantKey}/companymatch/vatnr

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/companymatch/vatnr
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The Tenant key that the matching should be done on behalf of.

Request body

liststring[] required

list of VAT Numbers

Example request

{
  "list": [
    "SE25555555550",
    "SE25555555551",
    "SE25555555552"
  ]
}

Response

Filtered list of VAT numbers that matched.

liststring[] required

list of VAT Numbers

Example response

{
  "list": [
    "SE25555555550",
    "SE25555555551",
    "SE25555555552"
  ]
}

Changes

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