Enroll an identity
Enrollment turns 3 to 5 good images of one person into an encrypted template. Enroll only people your organization has authorized.
POST
/v1/identities| Field | Meaning |
|---|---|
| external_subject_id | Your own ID for this person, unique within your organization |
| images | 3 to 5 JPEG or PNG files, multipart |
| display_label | Optional label for your console |
| research_use_allowed | Optional processing flag from your backend. Defaults to no research use |
| re_enroll | Set true to replace an existing template |
When enrollment is refused
- too_few_good_images: fewer than 3 images passed. details.samples says why for each.
- inconsistent_identity: the images don't appear to show one person.
- identity_exists: send re_enroll=true to replace it.
- identity_limit_reached: your plan's identity limit.
Managing identities
GET
/v1/identitiesGET
/v1/identities/{identity_id}PATCH
/v1/identities/{identity_id}DELETE
/v1/identities/{identity_id}Deleting destroys the template at once and purges retained captures. Setting research_use_allowed to false stops new research ingestion immediately and withdraws existing samples.