Document verification & selfie liveness
Invite the applicant to capture a government-issued ID and complete selfie liveness, then poll for the combined outcome.
What happens in the session
In the same hosted session the applicant first photographs a government-issued ID, then takes a live selfie. Peleza extracts identity fields from the document and confirms a real person is present whose face matches the portrait on the ID β not a print-out, screen replay, or still photo.
- Supported documents: national ID, passport, driving licence, residence permit (front, and back when required).
- Result fields: applicant.id_docs (type, number, country, date of birth, validity).
- Approved results include document and selfie images (and video selfie when captured), each with image_id, label, and a /media/identity URL.
- Failed liveness or a face-to-document mismatch appears as rejected on the fetch-result call.
Loading sandbox test IDsβ¦
Start verification
POST/api/v1/biometric/invite
{{baseUrl}}/api/v1/biometric/inviteHeader
Body Parameters
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": "Verification link 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",
"invitation_url": "https://verify.peleza.com/biometric/verify/aB3dE5fG7hJ9kL2mN4pQ6rS8tU0vW1xY2zA3bC4dE5fG",
"expires_at": "Oct 21, 2026 15:04"
}
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}Response Fields
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.
