{ "info": { "_postman_id": "3ca08ec4-433a-4f9e-9ef7-6813bb1f2844", "name": "ENGAGE Cloud Credentialing Access Codes Mobile Credentials API", "description": "REST API hosted on the Allegion Device Management and Mobile Access Cloud\n(Engage Cloud) for managing BLE Mobile Credentials that unlock ENGAGE Gen 2\nSchlage hardware (Control B, NDEB, LEBMS/LEBMD locks; MTKB readers) and\nVon Duprin RU/RM exit devices.\n\nThe Credentialing API performs functions to upload, delete, and get active\nlists of mobile credentials through the API, and is used by an Access\nManagement Platform / Access Control System (ACS) to issue credentials that\nthe Allegion BLE Mobile Access SDK then presents to hardware over Bluetooth.\n\nAuthentication requires an `alle-subscription-key` header plus a Basic Auth\ntoken generated from ENGAGE credentials. Integrators must sign the Allegion\nSecurity Token Agreement before being granted access to the API or to the\nprivate GitHub repositories that contain the iOS and Android SDKs.\n\nGenerated from public documentation at\nhttps://developer.allegion.com/en/products/schlage-mobile-credentials.\nPath naming is inferred from documented capability descriptions.\n\n\nContact Support:\n Name: Allegion Developer Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "lastUpdatedBy": "35240", "uid": "35240-3ca08ec4-433a-4f9e-9ef7-6813bb1f2844" }, "item": [ { "name": "credentials", "item": [ { "name": "{credentialId}", "item": [ { "name": "Get Mobile Credential", "id": "0ca4727c-b8a5-443b-acc1-f89ae60b01e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentialId", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentialId" ], "variable": [ { "id": "fe5ea204-65b6-4109-b60c-5745d2316255", "key": "credentialId", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "2061bf96-065a-49f5-9133-969b6918eadf", "name": "Credential returned", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentialId", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentialId" ], "variable": [ { "key": "credentialId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentialId\": \"\",\n \"userId\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"status\": \"Active\",\n \"accessProfile\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"createdAt\": \"\",\n \"revokedAt\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-2061bf96-065a-49f5-9133-969b6918eadf" }, { "id": "d28a1d74-73e1-418f-a821-002cf1404732", "name": "Credential not found in tenant.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentialId", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentialId" ], "variable": [ { "key": "credentialId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-d28a1d74-73e1-418f-a821-002cf1404732" } ], "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-0ca4727c-b8a5-443b-acc1-f89ae60b01e7" }, { "name": "Delete Mobile Credential", "id": "052a5c7c-1fd3-409f-a2b3-7869c7134724", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentialId", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentialId" ], "variable": [ { "id": "5febc658-1581-47d6-afe8-d18f95548b99", "key": "credentialId", "value": "", "description": "(Required) " } ] }, "description": "Revoke (delete) a mobile credential. Subsequent unlock attempts using the credential will be denied." }, "response": [ { "id": "a3437cfc-1149-4d00-ba40-9522d12703d0", "name": "Credential revoked", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentialId", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentialId" ], "variable": [ { "key": "credentialId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-a3437cfc-1149-4d00-ba40-9522d12703d0" }, { "id": "5708b08f-0b1f-4e95-bb4a-f803a3e71a63", "name": "Credential not found in tenant.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials/:credentialId", "host": [ "{{baseUrl}}" ], "path": [ "credentials", ":credentialId" ], "variable": [ { "key": "credentialId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-5708b08f-0b1f-4e95-bb4a-f803a3e71a63" } ], "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-052a5c7c-1fd3-409f-a2b3-7869c7134724" } ], "id": "62141e57-3b77-4096-8a7a-54ec045b3d7f", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-62141e57-3b77-4096-8a7a-54ec045b3d7f" }, { "name": "List Active Mobile Credentials", "id": "a7d9cb5d-9599-4166-8e19-c6019e4037df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/credentials?userId=&status=Revoked", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ], "query": [ { "description": "Filter by ACS user identifier.", "key": "userId", "value": "" }, { "key": "status", "value": "Revoked" } ] }, "description": "Returns the active mobile credentials in the integrator's ENGAGE tenant." }, "response": [ { "id": "b3f3c60e-83ac-4abd-adbb-94ff3666e501", "name": "Credentials returned", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials?userId=&status=Revoked", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ], "query": [ { "description": "Filter by ACS user identifier.", "key": "userId", "value": "" }, { "key": "status", "value": "Revoked" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentials\": [\n {\n \"credentialId\": \"\",\n \"userId\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"status\": \"Active\",\n \"accessProfile\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"createdAt\": \"\",\n \"revokedAt\": \"\"\n },\n {\n \"credentialId\": \"\",\n \"userId\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"status\": \"Expired\",\n \"accessProfile\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"createdAt\": \"\",\n \"revokedAt\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-b3f3c60e-83ac-4abd-adbb-94ff3666e501" }, { "id": "b8f3dfca-0ac1-4d6e-b06f-1936ab9fefe1", "name": "Missing or invalid subscription key / Basic Auth credentials.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/credentials?userId=&status=Revoked", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ], "query": [ { "description": "Filter by ACS user identifier.", "key": "userId", "value": "" }, { "key": "status", "value": "Revoked" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-b8f3dfca-0ac1-4d6e-b06f-1936ab9fefe1" } ], "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-a7d9cb5d-9599-4166-8e19-c6019e4037df" }, { "name": "Upload Mobile Credential", "id": "2d4efbb7-024c-43b6-b44e-b60f07664f75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"accessProfile\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ] }, "description": "Create (upload) a mobile credential for an ACS user. The credential is\ndelivered to the user's mobile device by the Allegion BLE Mobile Access\nSDK and is then presented over BLE to authorized ENGAGE hardware.\n" }, "response": [ { "id": "68c887bb-99c2-432f-bff5-50c5fff4f300", "name": "Credential created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"accessProfile\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentialId\": \"\",\n \"userId\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"status\": \"Active\",\n \"accessProfile\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"createdAt\": \"\",\n \"revokedAt\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-68c887bb-99c2-432f-bff5-50c5fff4f300" }, { "id": "7ab25744-ab87-4da6-823f-5160868802eb", "name": "Request validation failed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"accessProfile\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-7ab25744-ab87-4da6-823f-5160868802eb" }, { "id": "33cf26bb-d14e-488d-a75b-059a44f3977b", "name": "Missing or invalid subscription key / Basic Auth credentials.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "alle-subscription-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"accessProfile\": \"\",\n \"userEmail\": \"\",\n \"userName\": \"\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credentials", "host": [ "{{baseUrl}}" ], "path": [ "credentials" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-33cf26bb-d14e-488d-a75b-059a44f3977b" } ], "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-2d4efbb7-024c-43b6-b44e-b60f07664f75" } ], "id": "34091068-90ae-4f2b-8dfa-4e38c4e78cd6", "createdAt": "2026-07-28T00:29:32.000Z", "updatedAt": "2026-07-28T00:29:32.000Z", "uid": "35240-34091068-90ae-4f2b-8dfa-4e38c4e78cd6" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "alle-subscription-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.allegion.com/engage" } ] }