{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"668dfd9b-7d35-404b-b1c6-6a9c013176ef","name":"Suprema CLUeXfer API","description":"## Revision Note:\n\n- 2025/05/02\n    \n    - Created the Common folder and added the following endpoints.\n        \n        - Get Place and Door List\n            \n        - Face Verification\n            \n    - Created the Reservation folder and added the following endpoints.\n        \n        - Get Site Events\n            \n        - Create User\n            \n        - Update User\n            \n- 2025/02/21\n    \n    - Added API for getting all devices per location\n        \n    - Added pagination query parameter for all GET API request\n        \n    - Added total number of items for all GET API response\n        \n\n## **Overview**\n\nSuprema Japan's CLUeXfer API is a JSON-based API. All requests are made to endpoints beginning with [https://api.cluexfer.supremainc.com/api .](https://api.cluexfer.supremainc.com/api)\n\nThe API can be used to perform the following operations:\n\n- Get place and door list for a site\n    \n- Verify the face image of a user\n    \n- Issue Dynamic QR\n    \n- List all Dynamic QRs issues within a location\n    \n- List all Devices per Location\n    \n- Get the details of an issued Dynamic QR\n    \n- Delete a Dynamic QR\n    \n- Get the audit logs\n    \n- Create users for reservation\n    \n- Update users for reservation\n    \n- Get reservation site events\n    \n\n## **Getting started guide**\n\nTo start using CLUeXfer API,\n\n- You must use a valid API Key to send requests to the API endpoints. API Keys can be obtained from ClueXfer Portal or contact Suprema Japan Technical Support.\n    \n- The API has **300 per 5 minutes** request limit.\n    \n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.\n    \n- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n    \n\n## Authorization\n\nCLUeXfer API uses a fixed API Key for authorization (Auth Type: Bearer Token).\n\nWhen calling the API, you will need the API Key which will be provided to you by Suprema Japan Technical Support Agent or you can generate the API Key from ClueXfer portal if you are an administrator of the Dynamic QR site.\n\nNote：\n\n- API Keys have a 1-year expiration limit. At that time of expiration, please request or generate a new API Key.\n    \n- API Keys are location bound, meaning, it will only work in a specific location where it is set.\n    \n\n### Authorization error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n## Rate and usage limits\n\nAPI access rate limits apply at a per-API key basis in unit time. The limit is **300 requests per 5 minutes**. If you exceed the limit, your request will return an HTTP 429 Too Many Requests status code.\n\nEach API response returns the following set of headers to help you identify your use status:\n\n### 503 response\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, Suprema Japan Technical Support.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"41347317","team":6700537,"collectionId":"668dfd9b-7d35-404b-b1c6-6a9c013176ef","publishedId":"2sAYQdi9fs","public":true,"publicUrl":"https://apidocs.cluexfer.com","privateUrl":"https://go.postman.co/documentation/41347317-668dfd9b-7d35-404b-b1c6-6a9c013176ef","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"a42044"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Suprema DataXfer API Docs"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/355e50c7-b7eb-4bbb-abf9-a67da68d613e/U3VwcmVtYURhdGFYZmVyLXdoaXRlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"a42044"}},{"name":"light","logo":"https://content.pstmn.io/17501f2e-9377-461b-8bb2-547025b19e3c/U3VwcmVtYURhdGFYZmVyLWJsYWNrLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"a42044"}}]}},"version":"8.10.1","publishDate":"2025-01-31T02:33:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Suprema DataXfer API Docs","description":""},"logos":{"logoLight":"https://content.pstmn.io/17501f2e-9377-461b-8bb2-547025b19e3c/U3VwcmVtYURhdGFYZmVyLWJsYWNrLnBuZw==","logoDark":"https://content.pstmn.io/355e50c7-b7eb-4bbb-abf9-a67da68d613e/U3VwcmVtYURhdGFYZmVyLXdoaXRlLnBuZw=="}},"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/4e16000f40f8928a153c0cb8f3fd30564668a13de5bfad2fe0bcfa709788e7f6","favicon":"https://cluexfer.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"}],"canonicalUrl":"https://apidocs.cluexfer.com/view/metadata/2sAYQdi9fs"}