Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Tax identifiers

Creates a new tax identifier

Creates a new tax identifier object.

post/tax-identifiers

Request body

typestring required

The type of tax identifier.

valuestring required

The tax identifier.

Example request

{
  "type": "de",
  "value": "DE123456789"
}

Response

201 Created

idstring

The identifier of the tax identifier.

createdTimestring date-time

The time when the tax identifier was created.

customerIdstring nullable

The identifier of an existing customer.

typestring

Type of tax identifier.

valuestring

The tax identifier.

state'pending' | 'not_valid' | 'verified'

The verification state.

verifiedNamestring nullable

The registered name of the customer with this tax identifier.

verifiedAddressstring nullable

The registered address of the customer with this tax identifier.

updatedTimestring date-time

The time when the tax identifier was updated.

Example response

{
  "id": "5774321009",
  "createdTime": "2018-04-25T20:36:00Z",
  "customerId": "5774321009",
  "type": "de",
  "value": "DE123456789",
  "state": "pending",
  "stateTransitions": {
    "pending": "2018-04-25T20:36:00Z",
    "verified": "2018-04-25T20:36:00Z",
    "not_valid": "2018-04-25T20:36:00Z"
  },
  "verifiedName": ".",
  "verifiedAddress": ".",
  "updatedTime": "2018-04-25T20:36:00Z",
  "applicability": [
    {
      "country": "FR",
      "entity": "DR_Ireland-Entity",
      "customerType": "business"
    }
  ]
}