Allegion · Example Payload

Engage Upload Credential Example

Access ControlSmart LockSmart HomeMobile CredentialsBluetoothBLEIoTSecurityWebhooksOAuthSchlageVon DuprinENGAGE

Engage Upload Credential Example is an example object payload from Allegion, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

_metaresponse

Example Payload

Raw ↑ 
{
  "_meta": {
    "api": "ENGAGE Cloud Credentialing API",
    "operation": "uploadCredential",
    "request": {
      "method": "POST",
      "url": "https://api.allegion.com/engage/credentials",
      "headers": {
        "alle-subscription-key": "REPLACE_WITH_DEVELOPER_PORTAL_KEY",
        "Authorization": "Basic ZW5nYWdldXNlcjplbmdhZ2VwYXNzd29yZA==",
        "Content-Type": "application/json"
      },
      "body": {
        "userId": "acs-user-58213",
        "userEmail": "alex.jordan@example.com",
        "userName": "Alex Jordan",
        "accessProfile": "Site-NYC-HQ-AllDoors-Business-Hours",
        "validFrom": "2026-06-01T08:00:00Z",
        "validTo": "2026-12-31T23:59:59Z"
      }
    }
  },
  "response": {
    "status": 201,
    "body": {
      "credentialId": "cred-7b1e9b3c-6f02-4f3a-b5d1-8b80a2c6c11d",
      "userId": "acs-user-58213",
      "userEmail": "alex.jordan@example.com",
      "userName": "Alex Jordan",
      "status": "Active",
      "accessProfile": "Site-NYC-HQ-AllDoors-Business-Hours",
      "validFrom": "2026-06-01T08:00:00Z",
      "validTo": "2026-12-31T23:59:59Z",
      "createdAt": "2026-05-22T19:21:55Z",
      "revokedAt": null
    }
  }
}