Returns applications that have completed verification (i.e., have an EnrichmentProfile).
query Parameters
bulk_action_idintegerFilter applications by bulk action ID.
job_idintegerFilter applications by job ID.
orderingstringOrder results by field. Supported: 'enrichment_profile__created_at', '-enrichment_profile__created_at', 'name', '-name', 'stage', '-stage'
pageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringCase-insensitive substring match on applicant name (searches 'name').
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
List all verifications that have been completed with Tofu
path Parameters
idstring · required
Responses
idinteger · readOnly · requiredphonesstring · readOnly · requiredjobreadOnly · requiredenrichment_profilereadOnly · requiredis_eligible_for_verificationstring · readOnly · requiredallow_send_candidate_self_id_invitesstring · readOnly · requiredmissing_required_fields_for_verificationstring · readOnly · requiredidentity_request_email_sent_atstring · readOnly · requiredknown_fraud_flaggedboolean · readOnly · requiredWhether a known-fraud blocklist rule has hit this application. Survives a prior real verdict (tier stays BASIC/ADVANCED), so it's read from the rule-hit log, not the enrichment tier. Prefers the
known_fraud_flagged_annoqueryset annotation to avoid an N+1; falls back to a direct query for call sites that don't annotate.
namestring | nullemails| nulllinkedinstring | nullgithubstring | nullstagestring | null
Given an ATS application URL, fetch the corresponding application from Tofu
Responses
idinteger · readOnly · requiredphonesstring · readOnly · requiredjobreadOnly · requiredenrichment_profilereadOnly · requiredis_eligible_for_verificationstring · readOnly · requiredallow_send_candidate_self_id_invitesstring · readOnly · requiredmissing_required_fields_for_verificationstring · readOnly · requiredidentity_request_email_sent_atstring · readOnly · requiredknown_fraud_flaggedboolean · readOnly · requiredWhether a known-fraud blocklist rule has hit this application. Survives a prior real verdict (tier stays BASIC/ADVANCED), so it's read from the rule-hit log, not the enrichment tier. Prefers the
known_fraud_flagged_annoqueryset annotation to avoid an N+1; falls back to a direct query for call sites that don't annotate.
namestring | nullemails| nulllinkedinstring | nullgithubstring | nullstagestring | null
Mark an applicant as legitimate or fraudulent for an Application.
Request Body
idinteger · requiredApplication ID
labelrequiredApplicant label
fraudulent- fraudulentlegitimate- legitimate
reasonstringExplanation for the label
Responses
idinteger · readOnly · requiredphonesstring · readOnly · requiredjobreadOnly · requiredenrichment_profilereadOnly · requiredis_eligible_for_verificationstring · readOnly · requiredallow_send_candidate_self_id_invitesstring · readOnly · requiredmissing_required_fields_for_verificationstring · readOnly · requiredidentity_request_email_sent_atstring · readOnly · requiredknown_fraud_flaggedboolean · readOnly · requiredWhether a known-fraud blocklist rule has hit this application. Survives a prior real verdict (tier stays BASIC/ADVANCED), so it's read from the rule-hit log, not the enrichment tier. Prefers the
known_fraud_flagged_annoqueryset annotation to avoid an N+1; falls back to a direct query for call sites that don't annotate.
namestring | nullemails| nulllinkedinstring | nullgithubstring | nullstagestring | null
Trigger a verification run for an Application.
Request Body
idinteger · requiredApplication ID
tierEnrichment tier to use for verification. Defaults to ADVANCED if omitted (preserves prior implicit behavior).
BASIC- BASICADVANCED- ADVANCED
Responses
successboolean · requiredIndicates if the request was successfully handled.
statusrequiredVerification status
SUCCESS- SUCCESSIN_PROGRESS- IN_PROGRESSERROR- ERRORNOT_FOUND- NOT_FOUNDNOT_ENRICHED- NOT_ENRICHEDENRICHMENT_NOT_POSSIBLE- ENRICHMENT_NOT_POSSIBLE
messagestring · requiredHuman-readable message describing the status.
Returns Jobs that have at least one Application with a non-null EnrichmentProfile.
Accessibility:
- Superusers see jobs across all companies.
- Non-superusers are scoped to their portfolio company.
query Parameters
orderingstringOrder results by field. Supported: 'latest_enrichment', '-latest_enrichment', 'title', '-title', 'id', '-id'
pageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringCase-insensitive substring match on Job title
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
Get OpenMeter-backed entitlement details for a PortfolioCompany.
path Parameters
idstring · required
Responses
Entitlements summary JSON suitable for frontend gating.
customer_keystring · requiredbasic_verificationsobject · requiredadvanced_verificationsobject · requiredresume_screening_tokensobject · requiredinterview_scansobject · requireddeepfake_detectionobject · requiredseat_swappingobject · requiredscreening_agentobject · requiredfraud_agentobject · requireddeepfake_agentobject · required
Get entitlements for the authenticated user's PortfolioCompany.
Responses
Entitlements summary JSON suitable for frontend gating.
customer_keystring · requiredbasic_verificationsobject · requiredadvanced_verificationsobject · requiredresume_screening_tokensobject · requiredinterview_scansobject · requireddeepfake_detectionobject · requiredseat_swappingobject · requiredscreening_agentobject · requiredfraud_agentobject · requireddeepfake_agentobject · required
ViewSet for viewing ATSBulkAction records scoped to the user's PortfolioCompany.
query Parameters
orderingstringWhich field to use when ordering the results.
pageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringA search term.
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
ViewSet for viewing ATSBulkAction records scoped to the user's PortfolioCompany.
path Parameters
idstring · required
Responses
idinteger · readOnly · requiredjob_titlestring · readOnly · requiredjob_codestring · readOnly · requiredactionstring · readOnly · requiredcreated_atstring · date-time · readOnly · requiredupdated_atstring · date-time · readOnly · requirednum_applications_completedstring · readOnly · requirednum_applications_failedstring · readOnly · requirednum_applications_requestedstring · readOnly · requiredstagesstring · readOnly · required
completebooleanWhether the action has completed
report| nullThe report of the action
_metadata| nulldismissedbooleanWhether the action has been dismissed
List all verifications that have been completed with Tofu
Request Body
job_idinteger · requiredJob ID
stage_idsinteger[] · requiredList of Stage IDs
tierrequiredEnrichment tier to use for verification
BASIC- BASICADVANCED- ADVANCED
Responses
No applications found to verify (no action taken)
successboolean · requiredIndicates if the request was successfully handled.
messagestring · requiredHuman-readable message describing the status.
num_applicationsinteger · requiredNumber of applications to be verified.
bulk_action_idinteger | null · requiredID of the created BulkVerificationAction.
List all verifications that have been completed with Tofu
Responses
Credit and application summary returned successfully
successboolean · requiredIndicates if the request was successfully handled.
basic_credits_remaininginteger · requiredNumber of basic verification credits remaining.
advanced_credits_remaininginteger · requiredNumber of advanced verification credits remaining.
stagesobject[] · requiredList of stages with application counts.
num_job_applicationsinteger · requiredNumber of applications associated with the job.
job_idinteger · requiredID of the job.
has_basic_accessboolean · requiredIndicates if the user has basic verification access.
has_advanced_accessboolean · requiredIndicates if the user has advanced verification access.
is_basic_meteredboolean · requiredIndicates if the basic verification credits are metered.
is_advanced_meteredboolean · requiredIndicates if the advanced verification credits are metered.
Returns Jobs that have at least one Application.
query Parameters
orderingstringOrder results by field. Supported: 'title', '-title', 'id', '-id'
pageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringCase-insensitive substring match on Job title
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
Dismiss a bulk action.
Dismiss a bulk action.
path Parameters
idstring · required
Request Body
idinteger · readOnly · requiredjob_titlestring · readOnly · requiredjob_codestring · readOnly · requiredactionstring · readOnly · requiredcreated_atstring · date-time · readOnly · requiredupdated_atstring · date-time · readOnly · requirednum_applications_completedstring · readOnly · requirednum_applications_failedstring · readOnly · requirednum_applications_requestedstring · readOnly · requiredstagesstring · readOnly · required
completebooleanWhether the action has completed
report| nullThe report of the action
_metadata| nulldismissedbooleanWhether the action has been dismissed
Responses
Success
successboolean · requiredIndicates if the request was successfully handled.
messagestring · requiredHuman-readable message describing the status.
error_codestringMachine-readable error code identifying the error type.
Flag a LinkedIn profile as suspicious. Awards one credit to the flagger.
Request Body
linkedin_urlstring · uri · requiredflagged_reasonstring · minLength: 10 · required
namestring | null · minLength: 1titlestring | null · minLength: 1
Responses
messagestring · requiredcredits_earnedinteger · requiredcredits_remaininginteger · required
Paginated list of community flags for a given LinkedIn URL.
query Parameters
linkedin_urlstringpageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
Return the currently logged-in user's profile and stats.
Responses
idinteger · readOnly · requiredusernamestring | null · readOnly · requiredis_linkedin_tool_userboolean · readOnly · requiredmember_sincestring · readOnly · requiredcredits_earnedinteger · readOnly · requiredcredits_usedinteger · readOnly · requiredcredits_remaininginteger · readOnly · requiredprofiles_flaggedinteger · readOnly · requiredemail_verifiedboolean · readOnly · required
Paginated flag lists.
GET /flags/?linkedin_url=
query Parameters
linkedin_urlstringpageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringA search term.
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
Return paginated list of profiles the current user has flagged, with reasons.
query Parameters
linkedin_urlstringpageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringA search term.
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
Upload one file (a resume, a .csv/.xlsx of applicants, or a zip of resumes) and start a verification per applicant. Returns the batch immediately (status INGESTING); poll GET /v1/manual-uploads/{id}/ until READY or FAILED, then read the rows from GET /v1/manual-verifications/?manual_upload=
Request Body
filestring · uri · requiredverification_tierstring · enum · requiredBASIC- BASICADVANCED- ADVANCED
Enum values:BASICADVANCED
namestring · maxLength: 255Default:include_cross_networkbooleanDefault: true
Responses
idinteger · readOnly · requirednamestring · readOnly · requiredBatch name, usually the prospect/company the export is for. Searchable.
created_by_namestring | null · readOnly · requiredstatusreadOnly · requiredingestion_error_messagestring | null · readOnly · requiredwarningsreadOnly · requiredverification_countinteger · readOnly · requiredDefault: 0completed_countinteger · readOnly · requiredDefault: 0processing_countinteger · readOnly · requiredDefault: 0no_issues_countinteger · readOnly · requiredDefault: 0medium_countinteger · readOnly · requiredDefault: 0suspicious_countinteger · readOnly · requiredDefault: 0needs_info_countinteger · readOnly · requiredDefault: 0error_countinteger · readOnly · requiredDefault: 0verification_tierreadOnly · requiredinclude_cross_networkboolean · readOnly · requiredcreated_atstring · date-time · readOnly · requiredupdated_atstring · date-time · readOnly · required
Create a manual-upload batch (file upload or typed details) and poll its ingestion.
path Parameters
idstring · required
Responses
idinteger · readOnly · requirednamestring · readOnly · requiredBatch name, usually the prospect/company the export is for. Searchable.
created_by_namestring | null · readOnly · requiredstatusreadOnly · requiredingestion_error_messagestring | null · readOnly · requiredwarningsreadOnly · requiredverification_countinteger · readOnly · requiredDefault: 0completed_countinteger · readOnly · requiredDefault: 0processing_countinteger · readOnly · requiredDefault: 0no_issues_countinteger · readOnly · requiredDefault: 0medium_countinteger · readOnly · requiredDefault: 0suspicious_countinteger · readOnly · requiredDefault: 0needs_info_countinteger · readOnly · requiredDefault: 0error_countinteger · readOnly · requiredDefault: 0verification_tierreadOnly · requiredinclude_cross_networkboolean · readOnly · requiredcreated_atstring · date-time · readOnly · requiredupdated_atstring · date-time · readOnly · required
Type one applicant's details in (no resume file). The batch is born READY with a single verification already dispatched; read it from GET /v1/manual-verifications/?manual_upload=
Request Body
namestring · maxLength: 255 · requiredemailstring · email · requiredphonestring · maxLength: 32 · requiredverification_tierstring · enum · requiredBASIC- BASICADVANCED- ADVANCED
Enum values:BASICADVANCED
linkedinstring · uri · maxLength: 500Default:githubstring · uri · maxLength: 500Default:locationstring · maxLength: 255Default:work_experiencesobject[]include_cross_networkbooleanDefault: true
Responses
idinteger · readOnly · requirednamestring · readOnly · requiredBatch name, usually the prospect/company the export is for. Searchable.
created_by_namestring | null · readOnly · requiredstatusreadOnly · requiredingestion_error_messagestring | null · readOnly · requiredwarningsreadOnly · requiredverification_countinteger · readOnly · requiredDefault: 0completed_countinteger · readOnly · requiredDefault: 0processing_countinteger · readOnly · requiredDefault: 0no_issues_countinteger · readOnly · requiredDefault: 0medium_countinteger · readOnly · requiredDefault: 0suspicious_countinteger · readOnly · requiredDefault: 0needs_info_countinteger · readOnly · requiredDefault: 0error_countinteger · readOnly · requiredDefault: 0verification_tierreadOnly · requiredinclude_cross_networkboolean · readOnly · requiredcreated_atstring · date-time · readOnly · requiredupdated_atstring · date-time · readOnly · required
Flat list of the manual-upload verifications the caller may see, newest first: their own uploads, or the whole org's with fraud.view_team_manual_uploads (owners/admins). Rows have the same shape as /v1/verifications/ rows plus manual-upload context (created_by_name, manual_upload_id, resume_filename, created_at).
query Parameters
manual_uploadintegerOnly verifications belonging to this batch (track a just-created upload).
pageintegerA page number within the paginated result set.
page_sizeintegerNumber of results to return per page.
searchstringCase-insensitive substring match on name, email, or phone.
statusstringFilter by verification status: SUCCESS (complete), IN_PROGRESS (processing), ENRICHMENT_NOT_POSSIBLE (needs info), or ERROR.
Responses
countinteger · requiredExample: 123resultsobject[] · required
nextstring | null · uriExample: http://api.example.org/accounts/?page=4previousstring | null · uriExample: http://api.example.org/accounts/?page=2
The verifications inside manual-upload batches: flat list, detail, edit, re-run.
path Parameters
idstring · required
Responses
idinteger · readOnly · requiredphonesstring · readOnly · requiredjobreadOnly · requiredenrichment_profilereadOnly · requiredis_eligible_for_verificationstring · readOnly · requiredallow_send_candidate_self_id_invitesstring · readOnly · requiredmissing_required_fields_for_verificationstring · readOnly · requiredidentity_request_email_sent_atstring · readOnly · requiredknown_fraud_flaggedboolean · readOnly · requiredWhether a known-fraud blocklist rule has hit this application. Survives a prior real verdict (tier stays BASIC/ADVANCED), so it's read from the rule-hit log, not the enrichment tier. Prefers the
known_fraud_flagged_annoqueryset annotation to avoid an N+1; falls back to a direct query for call sites that don't annotate.created_atstring · date-time · readOnly · requiredcreated_by_namestring | null · readOnly · requiredmanual_upload_idinteger | null · readOnly · requiredresume_filenamestring | null · readOnly · required
namestring | nullemails| nulllinkedinstring | nullgithubstring | nullstagestring | null
Edit contact fields on a needs-info verification before re-running.
path Parameters
idstring · required
Responses
idinteger · readOnly · requiredphonesstring · readOnly · requiredjobreadOnly · requiredenrichment_profilereadOnly · requiredis_eligible_for_verificationstring · readOnly · requiredallow_send_candidate_self_id_invitesstring · readOnly · requiredmissing_required_fields_for_verificationstring · readOnly · requiredidentity_request_email_sent_atstring · readOnly · requiredknown_fraud_flaggedboolean · readOnly · requiredWhether a known-fraud blocklist rule has hit this application. Survives a prior real verdict (tier stays BASIC/ADVANCED), so it's read from the rule-hit log, not the enrichment tier. Prefers the
known_fraud_flagged_annoqueryset annotation to avoid an N+1; falls back to a direct query for call sites that don't annotate.created_atstring · date-time · readOnly · requiredcreated_by_namestring | null · readOnly · requiredmanual_upload_idinteger | null · readOnly · requiredresume_filenamestring | null · readOnly · required
namestring | nullemails| nulllinkedinstring | nullgithubstring | nullstagestring | null

