/v1/issuer/credentials/suspend_batch
API Key
Suspend multiple credentials
Suspend multiple credentials in a single request. Returns per-UUID results for debugging
and summary counts including suspended, not found, already suspended, and credentials
that cannot be suspended (revoked/pending).
Limit: Maximum 100 UUIDs per request.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
X-API-Key
*
|
header | string | Issuer API key for authentication |
* Required parameter
Request Body
Parameters for batch suspending credentials
uuids
*
array[string]
UUIDs of credentials to suspend (max 100)
Example: ["46dc3189-c0c6-489c-bad6-de0ffaaac902","3979740b-5237-4405-ab9d-a9badcdd3edf"]
Array items:
Response
Content-Type: application/json
success
boolean
data
object
Result of a batch operation (revoke_batch, suspend_batch, reinstate_batch). Contains per-UUID results for debugging and summary counts.
items
*
array[object]
Per-UUID results in submission order
Array items:
uuid
*
string (uuid)
The credential UUID
Example: 20ee86cc-9a3f-45df-9c64-21a3dfd5d38c
status
*
string
Result status for this credential
Allowed values: "already_active", "already_revoked", "already_suspended", "cannot_reinstate", "cannot_suspend", "not_found", "reinstated", "revoked", "suspended"
Example: revoked
summary
*
object
Aggregate counts by result status
total
*
integer
Total UUIDs processed
Example: 10
revoked
integer
Credentials successfully revoked (revoke_batch)
Example: 8
suspended
integer
Credentials successfully suspended (suspend_batch)
Example: 0
reinstated
integer
Credentials successfully reinstated (reinstate_batch)
Example: 0
not_found
integer
UUIDs that didn't match any credential
Example: 1
already_revoked
integer
Credentials already revoked
Example: 1
already_suspended
integer
Credentials already suspended
Example: 0
already_active
integer
Credentials already in active state
Example: 0
cannot_suspend
integer
Credentials that cannot be suspended (e.g., revoked)
Example: 0
cannot_reinstate
integer
Credentials that cannot be reinstated (e.g., revoked)
Example: 0
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.issuer(api_key=os.environ["AHO_API_KEY"])
result = client.credentials.suspend_batch(
body={
"uuids": ["46dc3189-c0c6-489c-bad6-de0ffaaac902", "3979740b-5237-4405-ab9d-a9badcdd3edf"]
}
)client = AhoSdk.issuer(api_key: ENV["AHO_API_KEY"])
result = client.credentials.suspend_batch(
body: {
uuids: ["46dc3189-c0c6-489c-bad6-de0ffaaac902", "3979740b-5237-4405-ab9d-a9badcdd3edf"]
}
)import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.issuer({ apiKey: process.env.AHO_API_KEY });
const result = await client.credentials.suspend_batch({
body: {
uuids: ["46dc3189-c0c6-489c-bad6-de0ffaaac902", "3979740b-5237-4405-ab9d-a9badcdd3edf"]
}
});curl -X POST 'https://api.aho.com/v1/issuer/credentials/suspend_batch' \
-H 'X-API-Key: $AHO_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"uuids": [
"46dc3189-c0c6-489c-bad6-de0ffaaac902",
"3979740b-5237-4405-ab9d-a9badcdd3edf"
]
}'Try It
Log in to test this endpoint directly from the documentation.
Log in