Skip to main content
GET
{base_url}
/
otk-service
/
v1
/
revoked-certificates
/
history
Revoked Certificates History
curl --request GET \
  --url https://api.example.com/{base_url}/otk-service/v1/revoked-certificates/history \
  --header 'Accept: <accept>' \
  --header 'Content-Type: <content-type>' \
  --header 'x-transaction-key: <x-transaction-key>'
{
    "success": true,
    "data": {
        "revoked_certificates": [
            {
                "journey_token": "0a5dbd66-ff32-4a42-8dec-9c9b421f9843",
                "reason": "Suspicious activity detected",
                "revoked_at": "2025-05-11T15:43:06.091018+04:00"
            },
            {
                "journey_token": "16d7e97d-de48-443e-b980-b8332ac0061b",
                "reason": "Document expiry",
                "revoked_at": "2025-05-01T18:32:45.260399+04:00"
            }
        ]
    },
    "message": "Revoked certificates retrieved successfully",
    "signature": "beee97425f5c...",
    "meta": {
        "timestamp": "2025-05-13T11:53:05.576Z",
        "filters": {
            "from_date": "2025-01-01",
            "to_date": "2025-12-31"
        },
        "pagination": {
            "total_count": 8,
            "page": 1,
            "page_size": 5,
            "has_more": true
        }
    },
    "errors": []
}
  • The maximum allowed date range is 90 days.
  • The maximum page_size is 100.
  • start_date must be earlier than or equal to end_date.

​
Authentication

​
x-transaction-key
string
required
Your API key. Get your key →
​
Accept
string
required
Must be application/json
​
Content-Type
string
required
Must be application/json

​
Query Parameters

​
start_date
string
required
Start date for the search range. Format: YYYY-MM-DD (10 characters).
​
end_date
string
required
End date for the search range. Format: YYYY-MM-DD (10 characters).
​
page
integer
default:"1"
Page number for pagination. Minimum: 1.
​
page_size
integer
default:"50"
Number of results per page. Range: 1–100.

​
Code Examples

curl "{base_url}/otk-service/v1/revoked-certificates/history?start_date=2025-01-01&end_date=2025-12-31&page=1&page_size=50" \
  -H "x-transaction-key: your-api-key" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

​
Response Fields

Response Structure
{
  "success": true,
  "data": { ... },         // Revoked certificate records
  "message": "...",
  "signature": "...",
  "meta": { ... },
  "errors": []
}
FieldTypePresenceDescription
successbooleanAlwaysWhether the request was successful.
messagestringAlwaysHuman-readable status message.
data.revoked_certificatesobject[]AlwaysList of revoked certificate records. Empty array when none found.
data.revoked_certificates[].journey_tokenstringAlwaysUnique journey identifier (UUID v4). Use with the Journey Details API for more context.
data.revoked_certificates[].reasonstringAlwaysHuman-readable reason for revocation (e.g., "Suspicious activity detected", "Document expiry").
data.revoked_certificates[].revoked_atstring (ISO 8601)AlwaysTimestamp when the certificate was revoked.
signaturestringAlwaysCryptographic signature for response verification.
meta.timestampstring (ISO 8601)AlwaysServer-side timestamp of the response.
meta.filters.from_datestringAlwaysThe start date filter applied (YYYY-MM-DD).
meta.filters.to_datestringAlwaysThe end date filter applied (YYYY-MM-DD).
meta.pagination.total_countintegerAlwaysTotal number of revoked certificates matching the filter.
meta.pagination.pageintegerAlwaysCurrent page number.
meta.pagination.page_sizeintegerAlwaysNumber of results per page.
meta.pagination.has_morebooleanAlwaystrue if there are additional pages of results.
errorsarrayAlwaysList of error objects. Each contains code, type, and message.

​
Next Steps

1
Investigate each revoked certificate
2
Use the journey_token to call the Journey Details API and understand the full context of the revoked verification.
3
Take action based on the revocation reason
4
  • Suspicious activity → Flag the customer in your system for review.
  • Document expiry → Initiate a Re-KYC journey to re-verify the customer.
    • 5
    Update your internal records
    6
    Mark the affected customer’s verification status as invalid in your database. Do not rely on a revoked certificate for any compliance or authorization decisions.
    7
    Run on a schedule
    8
    Set up a recurring job to monitor revoked certificates and automate remediation. Query the last 90 days to stay within the date range limit.
    {
    "success": true,
    "data": {
        "revoked_certificates": [
            {
                "journey_token": "0a5dbd66-ff32-4a42-8dec-9c9b421f9843",
                "reason": "Suspicious activity detected",
                "revoked_at": "2025-05-11T15:43:06.091018+04:00"
            },
            {
                "journey_token": "16d7e97d-de48-443e-b980-b8332ac0061b",
                "reason": "Document expiry",
                "revoked_at": "2025-05-01T18:32:45.260399+04:00"
            }
        ]
    },
    "message": "Revoked certificates retrieved successfully",
    "signature": "beee97425f5c...",
    "meta": {
        "timestamp": "2025-05-13T11:53:05.576Z",
        "filters": {
            "from_date": "2025-01-01",
            "to_date": "2025-12-31"
        },
        "pagination": {
            "total_count": 8,
            "page": 1,
            "page_size": 5,
            "has_more": true
        }
    },
    "errors": []
}