This guide walks you through the process of attaching a candidate's profile picture (reference selfie) via the API, without requiring a document upload. This is particularly useful when you want to use CheckHub Pass without collecting any document, and therefore without an existing candidate selfie extracted from a document.
Prerequisites:
- A valid API token (Authorization header). See How to Create Your First API Token.
- The candidate's ID.
- The picture file you want to use as the reference selfie.
Process
1. Upload the Picture as a Private Company File
Before it can be referenced as a selfie, the picture needs to exist in CheckHub as a file. Create it as a private company file using the File endpoint.
- Link to the API documentation: Create a file
Attention: Make sure to set isPublic=false so the file is stored as a private company file rather than being publicly accessible.
The response returns the new file's ID — keep it, you'll need it in the next step.
2. Reference the File as a Candidate Selfie
Once the file is uploaded, attach it to the candidate as their reference selfie using the Candidate Selfie endpoint.
- Link to the API documentation: Create a candidate selfie
You need to provide:
- The candidate ID
- The file ID (from step 1), passed as
frontId
Good to know: leftId and rightId are optional and can be ignored for this use case — only frontId is needed to set the reference picture.
That's it — the uploaded picture is now attached as the candidate's profile picture (reference selfie), with no document involved.
3. Use It with CheckHub Pass
Once a reference selfie is attached, you can use CheckHub Pass to validate a new on-site selfie (captured via QR code + live selfie) against this reference picture — even though no document was ever collected for this candidate.
Quick Reference
Step | Action | Auth Method |
1 | Upload the picture as a private company file ( isPublic=false) | Authorization (API token) |
2 | Reference the file as the candidate's selfie ( frontId) | Authorization (API token) |
3 | Validate on-site via CheckHub Pass | — |
Need Help?
Access the full API documentation here or explore the Postman collection for ready-to-use request examples.