System Status

Tax identifiers

The Tax identifier object represents a customer's tax identifier.

Returns a list of tax identifiers

get

Get all tax identifiers.

Authorizations
Query parameters
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

customerIdstringOptional

Only return tax identifiers for this customer.

typestringOptional

Only return tax identifiers of this type.

valuestringOptional

Only return tax identifiers with this value.

statestringOptional

Only return tax identifiers in this state.

pendingstring · date-timeOptional

A filter on the list based on the tax identifier stateTransitions pending field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions pending field is after this timestamp
  • gte - return values where the stateTransitions pending field is after or equal to this timestamp
  • lt - return values where the stateTransitions pending field is before this timestamp
  • lte - return values where the stateTransitions pending field is before or equal to this timestamp
verifiedstring · date-timeOptional

A filter on the list based on the tax identifier stateTransitions verified field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions verified field is after this timestamp
  • gte - return values where the stateTransitions verified field is after or equal to this timestamp
  • lt - return values where the stateTransitions verified field is before this timestamp
  • lte - return values where the stateTransitions verified field is before or equal to this timestamp
not_validstring · date-timeOptional

A filter on the list based on the tax identifier stateTransitions not_valid field. The value can be a string with an ISO-601 UTC format datetime or it can be a dictionary with the following options:

  • gt - return values where the stateTransitions not_valid field is after this timestamp
  • gte - return values where the stateTransitions not_valid field is after or equal to this timestamp
  • lt - return values where the stateTransitions not_valid field is before this timestamp
  • lte - return values where the stateTransitions not_valid field is before or equal to this timestamp
Responses
200
200 OK
application/json
get
GET /tax-identifiers HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "5774321009",
      "createdTime": "2025-07-01T02:50:47.851Z",
      "customerId": "5774321009",
      "type": "de",
      "value": "DE123456789",
      "state": "pending",
      "stateTransitions": {
        "pending": "2025-07-01T02:50:47.851Z",
        "verified": "2025-07-01T02:50:47.851Z",
        "not_valid": "2025-07-01T02:50:47.851Z"
      },
      "verifiedName": ".",
      "verifiedAddress": ".",
      "updatedTime": "2025-07-01T02:50:47.851Z",
      "applicability": [
        {
          "country": "FR",
          "entity": "DR_Ireland-Entity",
          "customerType": "business"
        }
      ]
    }
  ]
}

Creates a new tax identifier

post

Creates a new tax identifier object.

Authorizations
Body
typestringRequired

The type of tax identifier.

Example: de
valuestringRequired

The tax identifier.

Example: DE123456789
Responses
201
201 Created
application/json
post
POST /tax-identifiers HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "type": "de",
  "value": "DE123456789"
}
{
  "id": "5774321009",
  "createdTime": "2025-07-01T02:50:47.851Z",
  "customerId": "5774321009",
  "type": "de",
  "value": "DE123456789",
  "state": "pending",
  "stateTransitions": {
    "pending": "2025-07-01T02:50:47.851Z",
    "verified": "2025-07-01T02:50:47.851Z",
    "not_valid": "2025-07-01T02:50:47.851Z"
  },
  "verifiedName": ".",
  "verifiedAddress": ".",
  "updatedTime": "2025-07-01T02:50:47.851Z",
  "applicability": [
    {
      "country": "FR",
      "entity": "DR_Ireland-Entity",
      "customerType": "business"
    }
  ]
}

Gets a tax identifier by ID.

get

Retrieves the details of a tax identifier. You must supply the unique identifier of the tax identifier.

Authorizations
Path parameters
idstringRequired

Tax identifier ID

Responses
200
OK.
application/json
get
GET /tax-identifiers/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "5774321009",
  "createdTime": "2025-07-01T02:50:47.851Z",
  "customerId": "5774321009",
  "type": "de",
  "value": "DE123456789",
  "state": "pending",
  "stateTransitions": {
    "pending": "2025-07-01T02:50:47.851Z",
    "verified": "2025-07-01T02:50:47.851Z",
    "not_valid": "2025-07-01T02:50:47.851Z"
  },
  "verifiedName": ".",
  "verifiedAddress": ".",
  "updatedTime": "2025-07-01T02:50:47.851Z",
  "applicability": [
    {
      "country": "FR",
      "entity": "DR_Ireland-Entity",
      "customerType": "business"
    }
  ]
}

Deletes a tax identifier by ID.

delete

Permanently deletes a tax identifier. You must supply the unique identifier of the tax identifier.

Authorizations
Path parameters
idstringRequired

Tax identifier ID

Responses
204
204 No Content
delete
DELETE /tax-identifiers/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousSubscriptionsNextWebhooks

Last updated