Persons
Overview
The face recognition Persons API lets you create, list, retrieve, update, and delete person records used for enrollment, search, and verification. Each record typically includes a name, images (base64), optional demographics, collections, and server-side fields such as faceEncodings.
For the full field reference, see The Person Object.
API endpoints
Base path: https://api.verifik.co/v2/face-recognition/persons
| Action | Method & path | Documentation |
|---|---|---|
| Create | POST /v2/face-recognition/persons | Create a Person |
| Create with liveness | POST /v2/face-recognition/persons/search-live-face | Create a Person with Liveness |
| Lookup by name | GET /v2/face-recognition/persons/lookup | Lookup a Person by Name |
| List | GET /v2/face-recognition/persons | List All Persons |
| Retrieve | GET /v2/face-recognition/persons/{id} | Retrieve a Person |
| Update | PUT /v2/face-recognition/persons/{id} | Update a Person |
| Delete | DELETE /v2/face-recognition/persons/{id} | Delete a Person |
Person status (status field)
Common values on list/filter:
active— enrolled and usable for matching flowsinactive— not used for new operationspending— record not fully processed or approved
Use cases
- Onboarding — enroll users from ID capture or live capture flows
- Deduplication — liveness + search flows before creating a duplicate
- Access and fraud — maintain a gallery per collection or project