/
Customer tax number valid...

Customer tax number validated
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of customer tax number validation-related webhook event.

customerIdstring, <= 50 characters(CustomerId)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
taxIdNumberstring

Value of the tax number.

Example:"GB980780684"
taxIdTypestring

Type of the tax ID number.

Enum:"eu-vat""other"
isValidboolean

Determines if the tax number passed the EU official VIES validation.

eventTypestring

Type of event that triggered the webhook.

Value:"customer-tax-number-validated"
_embeddedobject

Embedded objects related to the customer tax number validation event.

Payload
{
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "taxIdNumber": "GB980780684",
  "taxIdType": "eu-vat",
  "isValid": true,
  "eventType": "customer-tax-number-validated",
  "_embedded": {
    "customer": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.