Send Biometric Invitation

Create a biometric verification invitation for a user. Returns an invitation URL the applicant can open to complete selfie/liveness and document capture.

Request

POST/api/v1/biometric/invite

{{baseUrl}}/api/v1/biometric/invite

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
email	string	Applicant email address	required
first_name	string	Applicant first name	required
last_name	string	Applicant last name	required
message	string	Optional note included in the invitation	optional

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Verification link created for jane@example.com.",
  "data": {
    "verification": {
      "name": "Jane Doe",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@example.com",
      "reference": "BIO-0042",
      "invitation_url": "https://example.com/biometric/verify/TOKEN",
      "expires_at": "Jul 21, 2026 15:04"
    }
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails

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.