BrandKwikID Documentation
API SuiteFace & Biometrics (ML)

Selfie Segmentation

Segment the human region from a selfie image. Server-side multipart POST with Bearer auth.

API reference

Try itLoading playground…
Loading…

Authorization

AuthorizationBearer <token>

JWT Bearer token authentication. Obtain a token from the KwikID dashboard.

In: header

Request Body

filestring
unique_id?string

Response Body

curl -X POST "https://__mock__/selfie_segmentation" \  -F file="string"
"string"
{
  "msg": "string"
}
{
  "detail": {},
  "message": "string"
}

Overview

Call POST /selfie_segmentation with Authorization: Bearer <token> and file multipart field. 200 returns a JPEG (gray background outside the subject). Use it to improve Facematch quality when backgrounds are noisy.

Key features

  • Cleaner probes: Reduces background clutter before matching.
  • Same auth model as other ML routes.

Implementation

Step 1: Call from your backend

Upload selfie file per OpenAPI.

Error handling

HTTP statusWhen
400Bad input image.
401Invalid token.

Benefits

  • Improves match scores on cluttered environments.

Next steps

Face Verification (v2) POST

Run face verification on an uploaded image. Multipart POST /v2/face_verification/verify — required file; optional unique_id.

Document Rect POST

Detect document corners and rectify a perspective warp. Server-side multipart POST with Bearer auth.