Ce guide vous accompagne dans le processus d'ajout de la photo de profil d'un contact (selfie de référence) via l'API, sans nécessiter l'envoi d'un document. Ceci est particulièrement utile lorsque vous souhaitez utiliser CheckHub Pass sans collecter de document, et donc sans selfie de contact existant extrait d'un document.
Prérequis :
- Un API token valide (header Authorization). Voir How to Create Your First API Token.
- L'ID du contact.
- La photo que vous souhaitez utiliser comme selfie de référence.
Processus
1. Envoyer la photo en tant que fichier privé de l'entreprise
Avant de pouvoir être référencée comme selfie, la photo doit d'abord exister dans CheckHub en tant que fichier. Créez-la comme fichier privé de l'entreprise via l'endpoint File.
- Lien vers la documentation API : Create a file
Attention : veillez à définir isPublic=false afin que le fichier soit enregistré comme fichier privé de l'entreprise plutôt que d'être accessible publiquement.
La réponse retourne l'ID du nouveau fichier — conservez-le, vous en aurez besoin à l'étape suivante.
2. Référencer le fichier comme selfie du contact
Une fois le fichier envoyé, associez-le au contact en tant que selfie de référence via l'endpoint Candidate Selfie.
- Lien vers la documentation API : Create a candidate selfie
Vous devez fournir :
- L'ID du contact
- L'ID du fichier (de l'étape 1), transmis en tant que
frontId
Bon à savoir : leftId et rightId sont optionnels et peuvent être ignorés dans ce cas d'usage — seul frontId est nécessaire pour définir la photo de référence.
Et voilà — la photo envoyée est désormais associée comme photo de profil (selfie de référence) du contact, sans qu'aucun document n'ait été impliqué.
3. Utilisation avec CheckHub Pass
Une fois le selfie de référence associé, vous pouvez utiliser CheckHub Pass pour valider un nouveau selfie pris sur place (via QR code + selfie en direct) par rapport à cette photo de référence — même si aucun document n'a jamais été collecté pour ce contact.
Référence rapide
Étape | Action | Méthode d'authentification |
1 | Envoyer la photo comme fichier privé de l'entreprise ( isPublic=false) | Authorization (API token) |
2 | Référencer le fichier comme selfie du contact ( frontId) | Authorization (API token) |
3 | Valider sur place via CheckHub Pass | — |
Besoin d'aide ?
Accédez à la documentation API complète ici ou explorez la collection Postman pour des exemples de requêtes prêts à l'emploi.