Match a list of VAT numbers to recipients for a specific tenant

POST

/v2/tenant/{tenantKey}/companymatch/vatnr

curl --request POST \
  --url https://sender.api.kivra.com/v2/tenant/example/companymatch/vatnr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "list": [ "SE559408724801", "SE556917354401", "SE556840226601" ] }'

• Production environment
• Sandbox environment

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.

Note: If none of the provided VAT numbers match a Recipient eligible to receive content from the given Tenant, an empty list will be returned.

Authorizations

• oAuth2Client
  post:kivra.v2.tenant.{tenantKey}.companymatch.vatnr

Parameters

Path Parameters

tenantKey

required

string format: hexadecimal

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

Request Body^required

List of VAT numbers to be matched. The payload can be up to 10MB in size, corresponding to about 500.000 VAT numbers.

Media typeapplication/json

CompanyMatchSet

object

list

required

List of VAT Numbers

Array<string>

Example

{
  "list": [
    "SE559408724801",
    "SE556917354401",
    "SE556840226601"
  ]
}

Responses

200

Filtered list of VAT numbers that matched.

Media typeapplication/json

CompanyMatchSet

object

list

required

List of VAT Numbers

Array<string>

Example

{
  "list": [
    "SE556840226601",
    "SE559408724801"
  ]
}

413

Payload exceeded 10MB — try splitting into multiple calls instead.