{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"998de4cd-0b7d-49e4-85ca-3b5407dd7f88","name":"API v2","description":"## Endpoints\n\n### Production\n\nRequest: `https://utanvet-ellenor.hu/api/v2/request`\n\nSignal: `https://utanvet-ellenor.hu/api/v2/signal`\n\n### Sandbox\n\nRequest: `https://sandbox.utanvet-ellenor.hu/api/v2/request`\n\nSignal: `https://sandbox.utanvet-ellenor.hu/api/v2/signal`\n\n## Authentication\n\n##### HTTP Basic Auth\n\nUsername: `Public API key`\n\nPassword: `Private API key`\n\n---\n\n## Request\n\n### Possible payload parameters\n\n| property | request type | explanation |\n| --- | --- | --- |\n| **email** | Request + Signal | Queried e-mail address, without any transformations. |\n| **threshold** | Request | Number between -1 and +1.  <br>More details [here](https://utanvet-ellenor.hu/knowledge-base/alapok/mi-a-kuszobertek-hogyan-mukodik). |\n| **outcome** | Signal | +1: successful  <br>\\-1: refused/unclaimed |\n| **orderId** | Request (optional) + Signal | Public-facing ID of the order.  <br>\\- example: #UV-12345 |\n| **countryCode** | Request (optional) + Signal (optional) | Country code in ISO 3166-1 alpha-2 format  <br>\\- example: HU |\n| **phoneNumber** | Request (optional) + Signal (optional) | Phone number in E.164 format, starting with the + sign.  <br>\\- example: +36209238883 |\n| **postalCode** | Request (optional) + Signal (optional) | Postal code the way it is used in the shipping address country.  <br>\\- example: 8640 |\n| **addressLine** | Request (optional) + Signal (optional) | Address line, without country, country code or postal code. Multiple address lines should be concatenated into one line.  <br>\\- example: Szigligeti utca 10. |\n\n### Required parameters\n\n#### Requests\n\n| parameter | basic | extended |\n| --- | --- | --- |\n| **email** | ✅ | ✅ |\n| **threshold** | ✅ | ✅ |\n| **phoneNumber** | ❌ | ✅ |\n| **countryCode** | ❌ | ✅ |\n| **postalCode** | ❌ | ✅ |\n| **addressLine** | ❌ | ✅ |\n| **orderId** | ❌ | ❌ |\n\n#### Signals\n\n| parameter | basic | extended |\n| --- | --- | --- |\n| **email** | ✅ | ✅ |\n| **outcome** | ✅ | ✅ |\n| **orderId** | ✅ | ✅ |\n| **phoneNumber** | ❌ | ✅ |\n| **countryCode** | ❌ | ✅ |\n| **postalCode** | ❌ | ✅ |\n| **addressLine** | ❌ | ✅ |\n\n---\n\n## Response\n\nThe API answers with a JSON string:\n\n``` json\n{\n    \"status\": 200,\n    \"result\": {\n        \"good\": 3,\n        \"bad\": 5,\n        \"reputation\": -0.25,\n        \"blocked\": true,\n        \"reason\": \"Total rate did not meet the minimum threshold set.\"\n    }\n}\n\n ```\n\n### Reasons & possible `status` values\n\nThe API will return an HTTP 200 status code if the request is processed, regardless its result. The `status` value in the response payload might be different based on the result of the request.\n\n| reason | status code |\n| --- | --- |\n| **Test hash was used.** | 200 |\n| **Run out of request quota for current billing period, upgrade your subscription to resolve!** | 402 |\n| **Active exception found for this hash in your account.** | 200 |\n| **Temporary e-mail was used.** | 204 |\n| **Mailbox does not exist.** | 204 |\n| **No Signals were found.** | 404 |\n| **Total rate did not meet the minimum threshold set.** | 200 |\n| **Signals found, checks passed.** | 200 |\n\n### Display results\n\nIf you would like to display these values, use the numeric `reputation` and/or `good` and `bad` values. Avoid aliasing these values with phrases, as they might mislead users.\n\n#### Examples of using the API responses in a UI:\n\n##### Good:\n\n- 3 successful, 2 failed (deliveries), reputation: 0.2\n    \n- 60% successful delivery rate\n    \n- `reason` value of the response (e.g. `Total rate did not meet the minimum threshold set.`)\n    \n\n##### Bad:\n\n- Order should not be fulfilled. (Why? No exact explanation is given.)\n    \n- Too much failed deliveries. (How much is \"too much\"?)\n    \n- Bad customer reputation. (What reputation is considered \"bad\"?)\n    \n\n---\n\n## Sandbox environment\n\nYou can use the sandbox environment with a separate registration at [https://sandbox.utanvet-ellenor.hu.](https://sandbox.utanvet-ellenor.hu.)\n\n**Please use this only when you are experimenting with your shop or integration.** _**Do not use it in production!**_\n\n> The sandbox API will behave the same as the production with one exception: the data it provides will be randomized - **don't use it in production!** \n  \n\n... one more thing: did I mention not to use Sandbox in production?\n\n---\n\n## F.A.Q.\n\n#### When to check for a Customer's reputation?\n\nIt is advised to check the customer's reputation seamlessly, in the background, during the checkout process.\n\nOne-page checkout: once the results are back, refresh the available payment methods with AJAX.\n\nMulti-page checkout: request the customer details before payment method selection.\n\n#### What to do if the customer fails the verification?\n\nHide cash on delivery payment methods.\n\n#### When to send a Signal (order outcome) to Utánvét Ellenőr API?\n\nOrder status changes are the endorsed and ideal events to trigger these API calls.\n\n#### What happens if multiple Signals are sent for the same Order?\n\nOur backend will search for previously submitted Signals, and if the new one has different outcome, the previously uploaded Signal will be updated instead of creating a new one.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"22853373","team":6769698,"collectionId":"998de4cd-0b7d-49e4-85ca-3b5407dd7f88","publishedId":"2sAYdioVSR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/22853373/2sAYdioVSR","privateUrl":"https://go.postman.co/documentation/22853373-998de4cd-0b7d-49e4-85ca-3b5407dd7f88","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"79098F"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Utánvét Ellenőr API documentation"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"79098F"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"79098F"}}]}},"version":"8.10.1","publishDate":"2025-03-03T18:01:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Utánvét Ellenőr API documentation","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/0913f17663ed2970062c1385f22d13120d74be1f911343175cedbc64ec8a54b8","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/2sAYdioVSR"}