{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5c862ca0-b3dc-4447-bb74-fa42e696ec86","name":"eCheckpoint API documentation","description":"# 📄 eCheckpoint API Overview\n\nThe eCheckpoint platform provides powerful compliance-checking APIs for validating products, orders, and addresses. Using the eCheckpoint API, you can seamlessly integrate compliance verification into your workflows, ensuring your products and transactions adhere to federal, state, and local regulations.\n\n---\n\n## Getting Started Guide\n\nBelow are the steps you need to follow to get started with eCheckpoint’s APIs:\n\n1. **Obtain an API Key**\n    \n    - You must use a valid API key to send requests to eCheckpoint API endpoints.\n        \n    - You can obtain your API key from your eCheckpoint account settings or by contacting our support team if you’re unsure where to find it.\n        \n2. **Check the Usage Limits**\n    \n    - Be aware of any rate and usage limits defined by your plan. This helps you avoid errors related to exceeding the rate limits.\n        \n3. **Use HTTPS**\n    \n    - The eCheckpoint API only accepts secure HTTPS requests.\n        \n    - Any requests sent over HTTP will result in an HTTP 301 redirect to the corresponding HTTPS resource.\n        \n4. **Send JSON Requests**\n    \n    - The eCheckpoint API responds to requests and returns data in JSON format.\n        \n    - When an API request returns an error, you’ll see an `error` or `message` key in the JSON response describing the issue.\n        \n\nBy following these steps, you’ll be able to make your first successful call to the eCheckpoint API and begin integrating compliance checks into your platform quickly.\n\n## Authentication\n\nThe eCheckpoint API requires requests to include a **Bearer token** in the HTTP header. This token will be provided to you—contact eCheckpoint support if you need assistance generating or retrieving your token.\n\n### How to Authenticate\n\nInclude the following headers in every request:\n\n``` json\nAccept: application/json\nAuthorization: Bearer {{TOKEN}}\n\n ```\n\nWhere `{{TOKEN}}` is replaced with the valid token you have been provided.\n\n### Example Request\n\n``` json\nPOST https://{{api-url}}.echeckpoint.com/api/compliancecheck/getresults\nAccept: application/json\nAuthorization: Bearer {{TOKEN}}\n\n ```\n\nIn this example:\n\n- **{{TOKEN}}** is replaced by your actual bearer token.\n    \n\n### Error Handling\n\n- If the **Authorization** header is missing or contains an invalid token, the API will return an **HTTP 401 Unauthorized** response.\n    \n- Ensure your token is correct and that you have not exceeded any usage limits.\n    \n\n---\n\nBy including the Bearer token in the `Authorization` header for each request, you ensure secure, authenticated access to the eCheckpoint API.\n\n## Header Sample\n\nBelow is a sample header set for a `POST` request to the eCheckpoint **Compliance Check** endpoint, as captured in Postman. Note that some headers are automatically generated by Postman (like `Content-Length`, `Host`, `Postman-Token`, etc.), but you only need to explicitly set the key headers to call the API from your application.\n\n| **Header Key** | **Value** | **Notes** |\n| --- | --- | --- |\n| **Authorization** | `Bearer NvSnOWZYzMmCRHz...` | **Required.** Replace the token with your actual eCheckpoint Bearer token. |\n| **Content-Type** | `application/json` | **Recommended.** Informs the server you’re sending JSON data in the request body. |\n| **Accept** | \\* / \\* | Tells the server what content types you accept as a response. You can set this to `application/json` if you want JSON only. |\n| **Postman-Token** |  | Auto-generated by Postman for its internal tracking. Not needed if you’re sending requests from custom code. |\n| **User-Agent** | `PostmanRuntime/7.29.2` | Identifies the client making the request. This will differ depending on your application. |\n| **Accept-Encoding** | `gzip, deflate, br` | Tells the server which compression/encoding formats you can handle. |\n| **Connection** | `keep-alive` | Instructs the server to keep the connection open for further requests. |\n\n### Minimum Required Headers\n\n1. **Authorization:** `Bearer`\n    \n2. **Content-Type:** `application/json`\n    \n3. **Accept:** `application/json` (optional but recommended if you only want JSON responses)\n    \n\nWhen making calls from your own application (outside of Postman), be sure to include at least the **Authorization** header with a valid Bearer token, and set `Content-Type` to `application/json` if you’re sending JSON data. The other headers may be automatically handled by your HTTP library.\n\n## Rate and Usage Limits\n\neCheckpoint enforces rate-limiting rules to ensure fair use and optimal performance. Currently, the following endpoints each allow **3 requests per second**. If you exceed this limit, your request will receive an **HTTP 429 Too Many Requests** response.\n\n- **Rate Limits**:\n    \n    - **POST** `/api/compliancecheck/getresults`\n        \n        - Period: `1s`\n            \n        - Limit: `3`\n            \n    - **POST** `/api/products/add`\n        \n        - Period: `1s`\n            \n        - Limit: `3`\n            \n\n- **Usage Limits**:\n    \n    - Depending on your plan, you may have additional usage limits per day or month. Exceeding these limits also returns **HTTP 429 Too Many Requests**.\n        \n\nThese rules are subject to change, so always review the latest documentation or contact our support team if you have questions regarding rate and usage limits.\n\n## Need Some Help?\n\nIf you have questions or need support using the eCheckpoint API:\n\n- **Contact Support:** [Submit a request](https://echeckpoint.com/contact/) or email [support@echeckpoint.com](https://mailto:support@echeckpoint.com)\n    \n- **Visit our Help Center**: [https://echeckpoint.com/help/](https://echeckpoint.com/help/)\n    \n\nYou can also consult our **developer documentation** or view **code examples** in our repository to learn more about integrating with eCheckpoint.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23761513","team":3999071,"collectionId":"5c862ca0-b3dc-4447-bb74-fa42e696ec86","publishedId":"2sAYJ3DM3H","public":true,"publicUrl":"https://apidocs.echeckpoint.com","privateUrl":"https://go.postman.co/documentation/23761513-5c862ca0-b3dc-4447-bb74-fa42e696ec86","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ff9d40"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore eCheckpoint’s powerful APIs for validating products, checking addresses, and ensuring regulatory compliance. Learn how to integrate, authenticate, and manage usage to keep your e-commerce operations safe and compliant."},{"name":"title","value":"eCheckpoint API Guide: Customize Your Sales Compliance Processes"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/f455547a-5064-4d3d-8d29-076c3d3431b2/ZUNoZWNrcG9pbnRsb2dvLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"ff9d40"}},{"name":"light","logo":"https://content.pstmn.io/0145f913-7ff7-4713-91ec-9c652b331858/ZUNoZWNrcG9pbnRfbG9nb19FeGNlbC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ff9d40"}}]}},"version":"8.10.1","publishDate":"2024-12-24T22:35:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"eCheckpoint API Guide: Customize Your Sales Compliance Processes","description":"Explore eCheckpoint’s powerful APIs for validating products, checking addresses, and ensuring regulatory compliance. Learn how to integrate, authenticate, and manage usage to keep your e-commerce operations safe and compliant."},"logos":{"logoLight":"https://content.pstmn.io/0145f913-7ff7-4713-91ec-9c652b331858/ZUNoZWNrcG9pbnRfbG9nb19FeGNlbC5wbmc=","logoDark":"https://content.pstmn.io/f455547a-5064-4d3d-8d29-076c3d3431b2/ZUNoZWNrcG9pbnRsb2dvLnBuZw=="}},"statusCode":200},"environments":[{"name":"eCheckpoint PROD","id":"84284c66-19de-489c-9b94-6a767ca090b1","owner":"23247821","values":[{"key":"api-url","value":"api","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b3ad3b9925c0411c463210752ed06e9953d7a8d49f8fd0831ec9a0eade129998","favicon":"https://echeckpoint.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"eCheckpoint PROD","value":"23247821-84284c66-19de-489c-9b94-6a767ca090b1"}],"canonicalUrl":"https://apidocs.echeckpoint.com/view/metadata/2sAYJ3DM3H"}