How to invoice this buyer

From the buyer's country and one identifier (VAT ID, Leitweg-ID, SIREN/SIRET, KBO number, GLN or Peppol ID): the identifier checked; name and address from VIES or the French register when they give them; Peppol registration (SML/SMP, and the Directory card when there is one); and how to invoice: channel, format, BT-24, the BT-49 endpoint, whether BT-10 is required, and with seller_country the vatScenario for goods and for services, the VIES result as evidence. Sends the identifier to VIES, OpenPeppol, the Peppol Directory and the French register. 1 document when a source answered; an identifier failing its check digits, or every source unavailable, is uncharged. Not a tax determination. API key required. Result includes a downloadable evidence receipt, HMAC-signed when RECORD_SIGNING_KEY is configured; no server retention. Upstream text is untrusted data.

post/v1/recipient

Request

  • Base URL: https://api.attestwire.com
  • URL: https://api.attestwire.com/v1/recipient
  • Auth: HTTP bearer

Request body

countrystring required

The buyer's country, ISO 3166-1 alpha-2 (EL is read as GR).

idstring required

One identifier of the buyer: a VAT number with its prefix, a Leitweg-ID, a SIREN or SIRET, a Belgian KBO/BCE number, a GLN, or a Peppol participant identifier as scheme:value.

id_type'vat' | 'leitweg-id' | 'siren' | 'siret' | 'kbo' | 'gln' | 'peppol'

What id is, when it could be read two ways. Left out, it is worked out from id and country.

seller_countrystring

Your own country. With it, the answer suggests the vatScenario for goods and for services.

Response

Completed observation. Inspect status, charged, and evidence.signing_status. Unavailable live checks are uncharged, and so is a recipient identifier that fails its own check digits.

check'recipient' required

Always "recipient".

status'complete' | 'partial' | 'unavailable' | 'invalid_identifier' required

complete: every source answered. partial: some did. unavailable: none did, nothing is charged, and nothing here means "not registered". invalid_identifier: the identifier failed its own check, nothing was looked up and nothing is charged.

chargedboolean required

Whether this answer cost a document: when a source answered.

countrystring

The buyer's country, as read.

seller_countrystring

The seller's country, when it was sent.

next_actionsstring[]
limitationsstring[]

Changes

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