Applicants
Group related documents for one person or entity.
Applicants let you group related documents for a single person or entity. This is useful for loan origination, identity verification and underwriting workflows, where you need to cross-verify several documents from the same applicant.
Sets versus individual documents
| Concept | Individual document | Document set (applicant) |
|---|---|---|
| Upload | POST /documents | Same, upload each document individually |
| Grouping | None, standalone | Assign applicant_id after upload |
| Results | GET /documents/{id} | Same per document, plus cross-verification via POST /verify |
| Analysis | Per-document fraud score | Cross-document verification across every applicant document |
Workflow
- Create an applicant with
POST /applicants. - Upload documents normally via
POST /documents. - Assign each document with
PUT /documents/{document_id}/applicant. - Run cross-verification with
POST /verify, passing the document IDs.
Assignment is reversible: send applicant_id: null to unassign a document
without deleting it.
Grouping is not required to verify
POST /verify takes document IDs directly, so you can cross-check documents
without creating an applicant first. Applicants are for when you want the
grouping to persist.
Endpoints
Request and response detail for all four operations is in the Applicants reference, generated from the OpenAPI spec.