Tofu Logo
Tofu Api

v1

Endpoint:https://chrome.hiretofu.com

GET
https://chrome.hiretofu.com
/v1/verifications/

Returns applications that have completed verification (i.e., have an EnrichmentProfile).

query Parameters

  • bulk_action_idinteger

    Filter applications by bulk action ID.

  • job_idinteger

    Filter applications by job ID.

  • orderingstring

    Order results by field. Supported: 'enrichment_profile__created_at', '-enrichment_profile__created_at', 'name', '-name', 'stage', '-stage'

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Case-insensitive substring match on applicant name (searches 'name').

Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?page=4
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?page=2

GET
https://chrome.hiretofu.com
/v1/verifications/{id}/

List all verifications that have been completed with Tofu

path Parameters

  • idstring · required

Responses

  • idinteger · readOnly · required
  • phonesstring · readOnly · required
  • jobreadOnly · required
  • enrichment_profilereadOnly · required
  • is_eligible_for_verificationboolean · readOnly · required

    An application is eligible for verification if it has a name, email, and resume

  • namestring | null
  • emailsobject | null
  • linkedinstring | null
  • githubstring | null
  • stagestring | null

POST
https://chrome.hiretofu.com
/v1/verifications/get_or_create_os_application_from_url/

Given an ATS application URL, fetch the corresponding application from Tofu

Request Body

  • application_urlstring · uri · required

    ATS application URL

Responses

  • idinteger · readOnly · required
  • phonesstring · readOnly · required
  • jobreadOnly · required
  • enrichment_profilereadOnly · required
  • is_eligible_for_verificationboolean · readOnly · required

    An application is eligible for verification if it has a name, email, and resume

  • namestring | null
  • emailsobject | null
  • linkedinstring | null
  • githubstring | null
  • stagestring | null

POST
https://chrome.hiretofu.com
/v1/verifications/set_applicant_label/

Mark an applicant as legitimate or fraudulent for an Application.

Request Body

  • idinteger · required

    OSApplication ID

  • labelrequired

    Applicant label

    • fraudulent - fraudulent
    • legitimate - legitimate
  • reasonstring

    Explanation for the label

Responses

  • idinteger · readOnly · required
  • phonesstring · readOnly · required
  • jobreadOnly · required
  • enrichment_profilereadOnly · required
  • is_eligible_for_verificationboolean · readOnly · required

    An application is eligible for verification if it has a name, email, and resume

  • namestring | null
  • emailsobject | null
  • linkedinstring | null
  • githubstring | null
  • stagestring | null

POST
https://chrome.hiretofu.com
/v1/verifications/verify/

Trigger a verification run for an Application.

Request Body

  • idinteger · required

    OSApplication ID

Responses

  • successboolean · required

    Indicates if the request was successfully handled.

  • statusrequired

    Verification status

    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
  • messagestring · required

    Human-readable message describing the status.

GET
https://chrome.hiretofu.com
/v1/verification-jobs/

Returns Jobs that have at least one OSApplication with a non-null EnrichmentProfile.

Accessibility:

  • Superusers see jobs across all companies.
  • Non-superusers are scoped to their portfolio company.

query Parameters

  • orderingstring

    Order results by field. Supported: 'latest_enrichment', '-latest_enrichment', 'title', '-title', 'id', '-id'

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Case-insensitive substring match on Job title

Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?page=4
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?page=2

GET
https://chrome.hiretofu.com
/v1/verification-jobs/{id}/

List Jobs that have at least one OSApplication with an EnrichmentProfile

path Parameters

  • idstring · required

Responses

  • idinteger · readOnly · required
  • num_verificationsinteger · readOnly · required
  • titlestring | null · maxLength: 500

GET
https://chrome.hiretofu.com
/v1/entitlements/{id}/summary/

Get OpenMeter-backed entitlement details for a PortfolioCompany.

path Parameters

  • idstring · required

Responses

Entitlements summary JSON suitable for frontend gating.

  • customer_keystring · required
  • basic_verificationsobject · required
  • advanced_verificationsobject · required
  • resume_screening_tokensobject · required
  • screening_agentobject · required
  • fraud_agentobject · required

GET
https://chrome.hiretofu.com
/v1/entitlements/me/summary/

Get entitlements for the authenticated user's PortfolioCompany.

Responses

Entitlements summary JSON suitable for frontend gating.

  • customer_keystring · required
  • basic_verificationsobject · required
  • advanced_verificationsobject · required
  • resume_screening_tokensobject · required
  • screening_agentobject · required
  • fraud_agentobject · required

GET
https://chrome.hiretofu.com
/v1/bulk-actions/

ViewSet for viewing ATSBulkAction records scoped to the user's PortfolioCompany.

query Parameters

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    A search term.

Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?page=4
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?page=2

GET
https://chrome.hiretofu.com
/v1/bulk-actions/{id}/

ViewSet for viewing ATSBulkAction records scoped to the user's PortfolioCompany.

path Parameters

  • idstring · required

Responses

  • idinteger · readOnly · required
  • job_titlestring · readOnly · required
  • actionstring · readOnly · required
  • created_atstring · date-time · readOnly · required
  • updated_atstring · date-time · readOnly · required
  • num_applications_completedstring · readOnly · required
  • num_applications_failedstring · readOnly · required
  • num_applications_requestedstring · readOnly · required
  • stagesstring · readOnly · required
  • completeboolean

    Whether the action has completed

  • reportobject | null

    The report of the action

  • _metadataobject | null
  • dismissedboolean

    Whether the action has been dismissed

POST
https://chrome.hiretofu.com
/v1/verifications/verify/bulk/jobs/

List all verifications that have been completed with Tofu

Request Body

  • job_idinteger · required

    Job ID

  • stage_idsinteger[] · required

    List of Stage IDs

  • tierrequired

    Enrichment tier to use for verification

    • BASIC - BASIC
    • ADVANCED - ADVANCED

Responses

No applications found to verify (no action taken)

  • successboolean · required

    Indicates if the request was successfully handled.

  • messagestring · required

    Human-readable message describing the status.

  • num_applicationsinteger · required

    Number of applications to be verified.

  • bulk_action_idinteger | null · required

    ID of the created BulkVerificationAction.

POST
https://chrome.hiretofu.com
/v1/verifications/verify/bulk/jobs/credits/

List all verifications that have been completed with Tofu

Request Body

  • job_idinteger · required

    Job ID

Responses

Credit and application summary returned successfully

  • successboolean · required

    Indicates if the request was successfully handled.

  • basic_credits_remaininginteger · required

    Number of basic verification credits remaining.

  • advanced_credits_remaininginteger · required

    Number of advanced verification credits remaining.

  • stagesobject[] · required

    List of stages with application counts.

  • num_job_applicationsinteger · required

    Number of applications associated with the job.

  • job_idinteger · required

    ID of the job.

  • has_basic_accessboolean · required

    Indicates if the user has basic verification access.

  • has_advanced_accessboolean · required

    Indicates if the user has advanced verification access.

  • is_basic_meteredboolean · required

    Indicates if the basic verification credits are metered.

  • is_advanced_meteredboolean · required

    Indicates if the advanced verification credits are metered.

GET
https://chrome.hiretofu.com
/v1/application-jobs/

Returns Jobs that have at least one OSApplication.

query Parameters

  • orderingstring

    Order results by field. Supported: 'title', '-title', 'id', '-id'

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Case-insensitive substring match on Job title

Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?page=4
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?page=2

GET
https://chrome.hiretofu.com
/v1/application-jobs/{id}/

List Jobs that have at least one OSApplication

path Parameters

  • idstring · required

Responses

  • idinteger · readOnly · required
  • num_applicationsinteger · readOnly · required
  • titlestring | null · maxLength: 500

Dismiss a bulk action.

POST
https://chrome.hiretofu.com
/v1/bulk-actions/{id}/dismiss/

Dismiss a bulk action.

Dismiss a bulk action. › path Parameters

  • idstring · required

Dismiss a bulk action. › Request Body

  • idinteger · readOnly · required
  • job_titlestring · readOnly · required
  • actionstring · readOnly · required
  • created_atstring · date-time · readOnly · required
  • updated_atstring · date-time · readOnly · required
  • num_applications_completedstring · readOnly · required
  • num_applications_failedstring · readOnly · required
  • num_applications_requestedstring · readOnly · required
  • stagesstring · readOnly · required
  • completeboolean

    Whether the action has completed

  • reportobject | null

    The report of the action

  • _metadataobject | null
  • dismissedboolean

    Whether the action has been dismissed

Dismiss a bulk action. › Responses

Success

  • successboolean · required

    Indicates if the request was successfully handled.

  • messagestring · required

    Human-readable message describing the status.

  • error_codestring

    Machine-readable error code identifying the error type.

Get the recently completed bulk actions for the user's PortfolioCompany.

GET
https://chrome.hiretofu.com
/v1/bulk-actions/recent/

Get the recently completed bulk actions for the user's PortfolioCompany.

Get the recently completed bulk actions for the user's PortfolioCompany. › Responses

Success

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?page=4
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?page=2
api