Path Parameters
The signature request ID returned from the create request endpoint
Query Parameters
Your OAuth app’s client ID. Used to verify you own this request.
Response
The current status of the signature request. One of:
pending - Waiting for user to signsigned - User has signed the payloaddenied - User denied the signature requestexpired - Request has expired
The cryptographic signature (only present when status is signed)
ISO 8601 timestamp when the request was resolved (signed, denied, or expired)
Code Example
import { getSignatureStatus } from "ave-sdk";
const config = {
clientId: "your_client_id",
issuer: "https://aveid.net", // optional
};
// Poll for signature status
const status = await getSignatureStatus(config, "request-id-here");
if (status.status === "signed") {
console.log("Signature received:", status.signature);
console.log("Signed at:", status.resolvedAt);
} else if (status.status === "denied") {
console.log("User denied the request");
} else if (status.status === "expired") {
console.log("Request expired");
} else {
console.log("Still pending...");
}
Polling Strategy
This endpoint is designed for polling. Recommended approach:
import { getSignatureStatus } from "ave-sdk";
const config = {
clientId: "your_client_id",
};
async function waitForSignature(requestId: string, timeoutMs = 300000) {
const startTime = Date.now();
while (Date.now() - startTime < timeoutMs) {
const result = await getSignatureStatus(config, requestId);
if (result.status !== "pending") {
return result;
}
// Wait 2 seconds before next poll
await new Promise(resolve => setTimeout(resolve, 2000));
}
throw new Error("Timeout waiting for signature");
}
const result = await waitForSignature("request-id-here");
console.log("Final status:", result.status);
Automatic Expiration
If a request’s expiration time has passed and the status is still pending, this endpoint will automatically update the status to expired and return that in the response.
Error Responses
Error message describing what went wrong
Common Errors
404 Not Found - Request ID not found403 Forbidden - The clientId does not match the app that created this request