Get Compliance Link

Generates a temporary, single-use URL for a customer to access the compliance web SDK. This URL allows customers to complete KYC/KYB (Know Your Customer/Business), AML (Anti-Money Laundering), and other compliance verification processes through a secure, hosted interface.

Endpoint

GET/v2/compliance/{customerId}/web_sdk_link

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Path Parameters

Parameter	Type	Description	Required	Example
customerId	string	Customer ID for compliance verification.	Yes	"DCalXLc-KRLb-ICUZ4pnjWNvo"

Headers

Key	Value	Required
Authorization	Bearer <JWT>	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns a temporary compliance link with its expiration time.

Response Fields

Field	Type	Description	Example
ttlInSeconds	integer	Time-to-live (seconds until link expires).	3600 (60 minutes)
url	string	Temporary compliance URL for customer to complete verification.	"https://compliance.example.com/sdk/abc123xyz"

Example Response:

json

{
  "ttlInSeconds": 900,
  "url": "https://compliance.example.com/sdk/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

---

Examples

Request

curl -X GET 'https://stagep.tst-apidmndelss.com/v2/compliance/DCalXLc-KRLb-ICUZ4pnjWNvo/web_sdk_link' \
  -H 'Authorization: Bearer eyJhbGci...wNLGA' \
  -H 'Accept: application/json'

Response

{
  "ttlInSeconds": 3600,
  "url": "https://in.sumsub.com/websdk/p/sbx_HNwutCtvO7FI5Xtc"
}

---

Error Responses

Customer Not Found:

{ "error": "Customer not found: DCalXLc-NRLb-ICUZ4pnjWNvo" }

Authorization fail

{ "error": "Unauthorized" }

---

Compliance Link Usage

The generated URL typically provides access to a hosted compliance form where customers can:

• Upload Identity Documents (passport, driver's license, etc.)
• Enter Personal Information (address, date of birth, etc.)
• Complete Questionnaire (source of funds, beneficial ownership, etc.)
• Submit Proof of Address (utility bills, bank statements, etc.)
• Verify Business Details (for corporate accounts)

---

Notes

• Single-Use: Links are typically designed for single use and expire after the TTL period
• Session Management: Opening the link starts a compliance verification session
• Status Tracking: Compliance status can be monitored via customer status
• Security: The URL contains encrypted tokens; do not share it publicly
• Reusability: Generate a new link if the previous one expires

Typical Workflow:

1. Customer requests compliance verification
2. System generates a temporary compliance link
3. Customer clicks link → Completes compliance form
4. System processes submitted information
5. Customer status updates (e.g., MODERATED → ACCEPTED)