API reference · Access & roles

Devices

GET/deviceList the caller's linked devices
POST/deviceLink a device
DELETE/device/{reference}Unlink one of the caller's devices
GET/device/{reference}Fetch one of the caller's linked devices by reference
POST/device/{reference}/blockBlock a device
POST/device/{reference}/unblockUnblock a previously blocked device

GET List the caller's linked devices

GET /device

Returns every device linked to the authenticated caller.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: List<DeviceResponse>

curl -X GET "https://api.bridgemoni.com/device" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "Ada Obi",
      "description": "March payroll",
      "deviceType": "IPHONE",
      "brandName": "Ada Obi",
      "operatingSystem": "Ada Obi",
      "deviceId": "a7f3-k2m9-4c1d-8e5b",
      "deviceKey": "device key",
      "status": "ACTIVE",
      "lastAccessDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List the caller's linked devices"
}

Responses

Status	When
`200`	Devices fetched successfully

POST Link a device

POST /device

Registers a new device against the authenticated caller. Only one device may be linked at a time - unlink the current one first to link a different device. The device identifier itself must also be globally unique.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: LinkDeviceRequest · Response: DeviceResponse

curl -X POST "https://api.bridgemoni.com/device" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ada Obi",
    "description": "March payroll",
    "deviceType": "IPHONE",
    "brandName": "Ada Obi",
    "operatingSystem": "Ada Obi",
    "deviceId": "a7f3-k2m9-4c1d-8e5b",
    "deviceKey": "device key",
    "deviceSecret": "text",
    "deviceSecretSignature": "device secret signature",
    "userData": "device user data",
    "userDataSignature": "user data signature"
  }'

{
  "name": "Ada Obi",
  "description": "March payroll",
  "deviceType": "IPHONE",
  "brandName": "Ada Obi",
  "operatingSystem": "Ada Obi",
  "deviceId": "a7f3-k2m9-4c1d-8e5b",
  "deviceKey": "device key",
  "deviceSecret": "text",
  "deviceSecretSignature": "device secret signature",
  "userData": "device user data",
  "userDataSignature": "user data signature"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "deviceType": "IPHONE",
    "brandName": "Ada Obi",
    "operatingSystem": "Ada Obi",
    "deviceId": "a7f3-k2m9-4c1d-8e5b",
    "deviceKey": "device key",
    "status": "ACTIVE",
    "lastAccessDateTime": "2027-03-14T14:30:01"
  },
  "description": "Link a device"
}

Responses

Status	When
`200`	Device linked successfully
`409`	This device is already linked to a user
`409`	Another device is already linked to this account

DELETE Unlink one of the caller's devices

DELETE /device/{reference}

Confirmed with the caller's transaction PIN, sent base64-encoded in the x-secret-value header as on any other PIN-protected operation. Unlinking is what frees the account to be linked somewhere else, so it is held to the same standard as moving money - possession of an unlocked handset is not enough on its own. Repeated wrong PINs lock the credential exactly as they do everywhere else.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: Void

curl -X DELETE "https://api.bridgemoni.com/device/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "description": "Unlink one of the caller's devices"
}

Responses

Status	When
`200`	Device unlinked successfully
`404`	No such device is linked to the authenticated caller

GET Fetch one of the caller's linked devices by reference

GET /device/{reference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: DeviceResponse

curl -X GET "https://api.bridgemoni.com/device/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "deviceType": "IPHONE",
    "brandName": "Ada Obi",
    "operatingSystem": "Ada Obi",
    "deviceId": "a7f3-k2m9-4c1d-8e5b",
    "deviceKey": "device key",
    "status": "ACTIVE",
    "lastAccessDateTime": "2027-03-14T14:30:01"
  },
  "description": "Fetch one of the caller's linked devices by reference"
}

Responses

Status	When
`200`	Device fetched successfully
`404`	No such device is linked to the authenticated caller

POST Block a device

POST /device/{reference}/block

A blocked device fails the X-Device-ID authentication check on every request.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: DeviceResponse

curl -X POST "https://api.bridgemoni.com/device/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/block" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "deviceType": "IPHONE",
    "brandName": "Ada Obi",
    "operatingSystem": "Ada Obi",
    "deviceId": "a7f3-k2m9-4c1d-8e5b",
    "deviceKey": "device key",
    "status": "ACTIVE",
    "lastAccessDateTime": "2027-03-14T14:30:01"
  },
  "description": "Block a device"
}

Responses

Status	When
`200`	Device blocked successfully
`404`	No such device is linked to the authenticated caller

POST Unblock a previously blocked device

POST /device/{reference}/unblock

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: DeviceResponse

curl -X POST "https://api.bridgemoni.com/device/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/unblock" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "deviceType": "IPHONE",
    "brandName": "Ada Obi",
    "operatingSystem": "Ada Obi",
    "deviceId": "a7f3-k2m9-4c1d-8e5b",
    "deviceKey": "device key",
    "status": "ACTIVE",
    "lastAccessDateTime": "2027-03-14T14:30:01"
  },
  "description": "Unblock a previously blocked device"
}

Responses

Status	When
`200`	Device unblocked successfully
`404`	No such device is linked to the authenticated caller

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors