POST
/api/v1/checker-widget/sdk/shareable-links/

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)

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Serializer for creating a shareable SDK link.

This serializer validates the input data required to create a reusable shareable verification link. The link can be shared with multiple users, and each user who accesses the link will get their own unique verification session.

Required Fields: - widget_id: UUID of the widget configuration to use for verification

Optional Fields: - metadata: Custom JSON metadata to attach to the shareable link - sdk_base_url: Custom SDK base URL (defaults to production) - expires_at: Custom expiry timestamp (max 30 days, defaults to no expiry)

Note: first_name, last_name, email are not required for generating the shareable link. These will be auto-generated when users access the link.

Example Request Body: { "widget_id": "123e4567-e89b-12d3-a456-426614174000", "metadata": {"campaign": "onboarding_2024"}, "expires_at": "2024-12-31T23:59:59Z" }

Response Body

application/json

curl -X POST "https://example.com/api/v1/checker-widget/sdk/shareable-links/" \  -H "Content-Type: application/json" \  -d '{    "widget_id": "917f3fdb-2905-481f-8ff6-04c0fb7d466c"  }'
{  "data": {    "short_url": "http://example.com",    "short_code": "string",    "expires_at": "2019-08-24T14:15:22Z",    "widget_name": "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