{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f3a8229e-a297-4adf-9d81-022e861c1cd7","name":"Trusted Sender Score API V2","description":"# Introduction\n\nThis is the API documentation for <a href=\"https://zuluedm.com/trusted-sender\">Trusted Sender Score</a>\n\nThe Trusted Sender Score of a domain is an assessment of a domain's email behavior and configuration. The score can range from between 0-10 and comprises of key email and subscriber metrics that factor in privacy, interactions, anti-spoof measures and transparency ensuring that a balanced and reliable scores is made available.\n\nThis application programming interface (API) gives developers access to Trusted Sender Score Domain Verification information and associated data that can be used to enhance the reliability of applications that transact using email, improve accuracy and response times for email filtering and for the protection of employees against email cyber attack.\n\n## API Overview\n\nThe score for each domain is for the **host domain only.** The score is returned using JSON. The returned JSON file is key => value pairs. The color and description are to be used as they represent the official branding and user recognition criteria that developers should consider when designing their user interface. The parameters include:\n\n*   **TS Score** (float,2)\n*   **TS Status** Verified, Caution, Alert, **Temp** (V, C, A) and **Non Sending** (V,C,A)\n*   **TS Color** (the four official colors that must be used when presenting a visual alert). If you implement the colors (recommended) then when we update a color your app will reflect any changes\n*   **TS Description** (Key recommendations for the user viewing the score)\n    \n\nFor domains that do not exist in the dataset a temporary score will be returned. The difference between a temp score and a complete analysis of a domain is clear in the return message.\n\n# GET\n\n*   **domain** - .../domain/zululabs.com will return the Trusted Sender Score and associated variables as described above.\n*   **multi-domain** .../multi-domain/zuluedm.com,info.marketing,zululabs.com,jetbrains.com\n    *   A minimum of 2 host domains must be called and a maximum of 30. We suggest caching the results for 14 days.\n    *   You must **URLEncode** your list of domains from **zuluedm.com,info.marketing,zululabs.com,jetbrains.com => zuluedm.com,info.marketing,zululabs.com,jetbrains.com**\n*   **host-domain** ../host-domain/zuluedm.com,info.marketing,zululabs.com,jetbrains.com\n    *   A minimum of 2 host domains must be called and a maximum of 30. We suggest caching the results for 14 days.\n    *   You must **URLEncode** your list of domains from **zuluedm.com,info.marketing,zululabs.com,jetbrains.com => \n\n# Authentication\n\n<a href=\"https://zuluedm.com/trusted-sender/1.0/registration.php\">Register for API access</a> using the Trusted Sender Score web interface. You will be issued a token. Include this token with your username and password in the headers when connecting to the API. Developers can access the API for free however the full API will not be unlocked until you are an accredited partner or a paying client.\n\nThe following 3 variables must be included in the header:\n\n*   X-API-USERNAME\n*   X-API-PASSWORD\n*   X-API-TOKEN\n    \n\n### There is no personal information accessible using this API\n\n## Response Codes\n\n*   200 - OK\n*   401 - No API Access\n*   402 - Not registered or failed host check\n*   404 - Empty string\n*   405 - Incorrect number of domains\n*   406 - Score building time out\n*   407 - Error\n    \n\n## Rate limit\n\nThere is an intention to throttle the number of requests that can be made using the API\n\n## Examples\n\nPlease visit this Github repository for code examples:\n\n*   [https://github.com/zululabs/trusted-sender-score-api-examples](https://github.com/zululabs/trusted-sender-score-api-examples)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9652925","team":39974398,"collectionId":"f3a8229e-a297-4adf-9d81-022e861c1cd7","publishedId":"UVkqquJn","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9652925/UVkqquJn","privateUrl":"https://go.postman.co/documentation/9652925-f3a8229e-a297-4adf-9d81-022e861c1cd7","customColor":{"top-bar":"4285f4","right-sidebar":"303030","highlight":"47a44b"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.12.6","publishDate":"2022-02-27T07:45:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/c70eae5b5327d701136a3cdfbdb8c35d1e8b8cdea5ae76bf32e0d70c13483e65","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVkqquJn"}