Prembly
GuidesAPI Reference
SDKs and PluginsList verification sessions GET
GET
/api/v1/checker-widget/sdk/sessions/

Retrieve a paginated list of all SDK verification sessions for the authenticated organization.

Features:

  • Lightweight data for fast performance (no full verification data)
  • Paginated results (default: 20 per page)
  • Ordered by creation date (newest first)
  • Includes basic session information only

For Full Details: Use GET /sessions/{session_id}/report/ to get comprehensive verification data

Filtering:

  • Filter by status: ?status=completed
  • Search by email: ?email=user@example.com
  • Search by session_id: ?session_id=xxx

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/checker-widget/sdk/sessions/"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "session_id": "string",      "status": "initiated",      "full_name": "string",      "end_user_email": "user@example.com",      "end_user_phone": "string",      "widget_name": "string",      "widget_config": "string",      "overall_result": "string",      "failure_reason": "string",      "total_cost": "string",      "currency": "string",      "started_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z",      "duration": "string",      "created_at": "2019-08-24T14:15:22Z",      "is_used": true,      "verification_steps_completed": "string",      "metadata": "string"    }  ],  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Check async verification status GET

Check the status of an asynchronous verification request. **Statuses:** - `pending`: Request queued, waiting to be processed - `processing`: Currently being processed - `success`: Completed successfully - `failed`: Verification failed (invalid data, etc.) - `error`: System error occurred **Polling:** - Poll every 2-5 seconds until status is not 'pending' or 'processing' - Maximum processing time: 30 seconds

Create a shareable link POST

Create a reusable shareable verification link. This endpoint creates a short link that can be shared with multiple users. Each user who accesses the link will get their own unique verification session. **Features:** - Reusable link for multiple users - URL shortening (e.g., https://app.prembly.com/start/yhfkAqt) - Click tracking - Optional custom expiry (max 30 days) - No user details required at creation time **Authentication:** - Bearer Token (JWT) - API Key (X-API-Key header)