---
title: Ping Taxjar service to validate credentials.
slug: amberflo-api/ping-taxjar-service-to-validate-credentials
docTags: 
createdAt: 2024-11-07T15:10:16.979Z
---

{
  "id": "PxFN0jWLwaGl8q4eJxnlH",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://app.amberflo.io/integration/tax/ping/taxjar",
    "servers": [
      {
        "url": "https://app.amberflo.io/integration/tax/ping/taxjar"
      }
    ],
    "name": "Ping Taxjar service to validate credentials.",
    "description": "",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "description": "",
          "customType": "com.amberflo.integration.tax.AccountIntegrationDetail.in",
          "schema": [
            {
              "name": "username",
              "kind": "optional",
              "type": "string",
              "description": "User name or account id etc.",
              "example": ""
            },
            {
              "name": "password",
              "kind": "optional",
              "type": "string",
              "description": "API key, password, license key (such as Avalara), etc.",
              "example": ""
            },
            {
              "name": "companyCode",
              "kind": "optional",
              "type": "string",
              "description": "Company code for the integration if applicable, such as Avalara.",
              "example": ""
            },
            {
              "name": "environment",
              "kind": "optional",
              "type": "string",
              "description": "Environment that the account integration detail is used for if applicable. Such as sandbox or production",
              "example": ""
            }
          ],
          "modelRef": "#/components/schemas/com.amberflo.integration.tax.AccountIntegrationDetail.in",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKey",
          "name": "X-API-KEY",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Successful request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "com.amberflo.integration.tax.PingResponse.out",
            "schema": [
              {
                "name": "authenticated",
                "kind": "optional",
                "type": "boolean",
                "description": "Whether or not the credentials are authenticated",
                "example": ""
              },
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "The error message if not authenticated",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/com.amberflo.integration.tax.PingResponse.out",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "MzLOor-Kj5Vk3488RO6-b",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://app.amberflo.io/integration/tax/ping/taxjar \\\n     --header 'accept: application/json'"
        },
        {
          "id": "BJjwq0a5EMSQdzWcqsqqp",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/integration/tax/ping/taxjar\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "X6DoYlDbqZCAvuVn55LaP",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/integration/tax/ping/taxjar\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "EE_9nGMWUrELj6hXD8TWB",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/integration/tax/ping/taxjar\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "MzLOor-Kj5Vk3488RO6-b"
    },
    "results": {
      "languages": [
        {
          "id": "eyvIUeQG28HoBAOVMcwcm",
          "language": "200",
          "code": "// Successful request\n{\n  \"authenticated\": false,\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "eyvIUeQG28HoBAOVMcwcm"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}