Peleza β€” Trust built on data
Biometric Verification
On this page

Embedded WebSDK

Keep applicants on your website. Create an embedded session, mint a short-lived SDK token from your backend, and run Sumsub’s WebSDK in your page. Hosted invitation links (POST /api/v1/biometric/invite) stay unchanged.

Integration flow

1) POST /api/v1/biometric/embedded/sessions β†’ reference. 2) POST /api/v1/biometric/embedded/{reference}/sdk-token β†’ access_token (Bearer, backend only). 3) Initialize Sumsub WebSDK on your page with that token. 4) Poll GET /api/v1/biometric/{reference}. Do not use the public hosted start endpoint for embedded sessions, and never put Peleza client secrets in the browser.

  • Separate from hosted invite β€” no invitation_url and no redirect to verify.peleza.com.
  • Mint token: POST /api/v1/biometric/embedded/{reference}/sdk-token (same Bearer auth as other private routes).
  • Result polling reuses GET /api/v1/biometric/{reference}; billing uses the same biometric pricing as hosted invites.
Loading sandbox test IDs…

Create embedded session

POST/api/v1/biometric/embedded/sessions
{{baseUrl}}/api/v1/biometric/embedded/sessions
HeaderTypeDescription
AuthorizationstringBearer YOUR_ACCESS_TOKEN from the OAuth client-credentials flow
Content-Typestringapplication/json

Body Parameters

ParameterTypeDescriptionRequired
emailstringApplicant email addressrequired
first_namestringApplicant first namerequired
last_namestringApplicant last namerequired
messagestringOptional note stored with the sessionoptional
consentbooleanMust be true β€” confirms data-subject consent to perform this verificationrequired

Request payload

All verification APIs require consent: true in the JSON body.

Sample dataRequest payload
{
  "email": "john.doe@example.com",
  "first_name": "JOHN DOE",
  "last_name": "JOHN DOE",
  "message": "sample-value",
  "consent": true
}

Expected response

200 OKSample dataExpected response
{
  "success": true,
  "response_code": 200,
  "message": "Embedded verification session created for jane@peleza.com.",
  "data": {
    "verification": {
      "name": "Jane Doe",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@peleza.com",
      "reference": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
      "delivery": "embedded",
      "expires_at": "Oct 21, 2026 15:04"
    }
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

FieldTypeDescription
successbooleanWhether the request succeeded
response_codenumberApplication response code (typically mirrors HTTP)
messagestringHuman-readable status message
dataobjectPayload for the verified resource
request_idstringUUID for support and audit trails
data.verification.referencestringVerification UUID. Pass this to sdk-token and GET /api/v1/biometric/{reference}.
data.verification.deliverystringAlways embedded for this endpoint
data.verification.expires_atstringWhen the session expires
data.verification.emailstringApplicant email
data.verification.first_namestringApplicant first name
data.verification.last_namestringApplicant last name
data.verification.namestringApplicant full name

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.