vellTRDocs
Back to API Reference

Onboarding & KYC

Read merchant/submerchant KYC status and introspect the authenticated subject. Payments require an approved status.

2 endpoints
GET/v1/kyc/statusOptional

Report the merchant's KYC decision. status ∈ none | pending | approved | rejected | suspended | expired. Payments are allowed only when status === "approved".

JSONResponse Example
{
  "status": "approved",
  "decidedAt": "2026-04-10T09:00:00Z",
  "sessionId": "f1c9a2e6-b4d4-e8a9-c1f2-a7b8c9d0e1f3",
  "subjectId": "sbj_3c4d5e6f7081"
}
GET/v1/auth/whoamiOptional

Introspect the authenticated subject from the verified API key. Reports whether the caller is a merchant or a submerchant and its scope.

JSONResponse Example
{
  "subjectScope": "merchant",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "apiKeyId": "key_708192a3b4c5"
}

Category Summary

Total Endpoints

2

Base Domain

api.pay.kvell.group