Country specifications

The Country Specifications resource streamlines the checkout process by providing detailed schemas based on the selling entity and country combination. It assists in determining the necessity and format of address components and tax identifiers, ensuring compliance with country-specific requirements. By leveraging this API, businesses can enhance their international operations and reduce friction during cross-border transactions.

The API returns schemas based on the and country combination you provide. You can then use these schemas to determine whether an address component or tax identifier is required and also whether it is properly formatted.

PreviousCheckouts NextCustomers

Last updated 3 months ago

Returns an array containing a country specification

Gets a country specification.

get

/country-specs

Authorizations

Query parameters

countrystringrequired

Represents the expected billing or ship to country of the customer.

sellingEntitystringrequired

Represents the selling entity assigned to the order.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/country-specs?country=text&sellingEntity=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "data": [
    {
      "country": "US",
      "sellingEntity": "DR_IRELAND-ENTITY",
      "billingAddressSchema": "text",
      "shippingAddressSchema": "text",
      "billingAddressOnlySchema": "text",
      "taxIdentifiersInfo": {
        "type": "ie",
        "isRequired": false,
        "formatPattern": "^[Ii][Ee]\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z]$|^[Ii][Ee]\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z]$|^[Ii][Ee]\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z][A-Za-z]$|^[Ii][Ee]\\\\d[A-Za-z]\\\\d\\\\d\\\\d\\\\d\\\\d[A-Za-z]$",
        "locales": "en_IE",
        "customerType": "business"
      },
      "invoiceAttributeInfo": {
        "isRequired": false,
        "individual": {
          "attributes": {
            "invoiceTitle": "Invoice title",
            "regAccount": "87654",
            "regAddress": "123 Example st.",
            "regBank": "Bank",
            "regPhone": "8005551234"
          },
          "type": "cn_individual_general"
        },
        "business": {
          "type": "cn_business_general",
          "attributes": [
            {
              "invoiceTitle": "Invoice title",
              "regAccount": "87654",
              "regAddress": "123 Example st.",
              "regBank": "Bank",
              "regPhone": "8005551234"
            }
          ]
        }
      },
      "liveMode": false,
      "individualTaxIdentifiersSchemas": [
        "text"
      ],
      "businessTaxIdentifiersSchemas": [
        "text"
      ]
    }
  ]
}

200 OK