Tofu Logo
Tofu Api

Schemas

EnrichmentProfilePublic

  • fraud_ratingstring | null · readOnly · required
  • verification_ran_bystring | null · readOnly · required
  • created_atstring · date-time · readOnly · required
  • enrichment_tierstring · enum · required
    • BASIC - BASIC
    • ADVANCED - ADVANCED
    Enum values:
    BASIC
    ADVANCED
  • probability_fraudulentnumber | null · double

    A value between 0 and 1 representing the probability of a user being fraudulent

  • statusstring · enum
    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
    Enum values:
    SUCCESS
    IN_PROGRESS
    ERROR
    NOT_FOUND
    NOT_ENRICHED
  • explanation | null
  • user_provided_labelstring · enum
    • NO_USER_LABEL - NO_USER_LABEL
    • MARKED_FRAUDULENT - MARKED_FRAUDULENT
    • MARKED_LEGITIMATE - MARKED_LEGITIMATE
    Enum values:
    NO_USER_LABEL
    MARKED_FRAUDULENT
    MARKED_LEGITIMATE
  • recruiter_provided_labelstring · enum
    • NO_USER_LABEL - NO_USER_LABEL
    • MARKED_FRAUDULENT - MARKED_FRAUDULENT
    • MARKED_LEGITIMATE - MARKED_LEGITIMATE
    Enum values:
    NO_USER_LABEL
    MARKED_FRAUDULENT
    MARKED_LEGITIMATE

JobPublic

  • idinteger · required
  • titlestring · required

OSApplicationPublic

  • 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

PaginatedOSApplicationPublicList

  • 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

StatusEnum

string · enum
Enum values:
SUCCESS
IN_PROGRESS
ERROR
NOT_FOUND
NOT_ENRICHED
  • SUCCESS - SUCCESS
  • IN_PROGRESS - IN_PROGRESS
  • ERROR - ERROR
  • NOT_FOUND - NOT_FOUND
  • NOT_ENRICHED - NOT_ENRICHED

UserProvidedLabelEnum

string · enum
Enum values:
NO_USER_LABEL
MARKED_FRAUDULENT
MARKED_LEGITIMATE
  • NO_USER_LABEL - NO_USER_LABEL
  • MARKED_FRAUDULENT - MARKED_FRAUDULENT
  • MARKED_LEGITIMATE - MARKED_LEGITIMATE

LabelEnum

string · enum
Enum values:
fraudulent
legitimate
  • fraudulent - fraudulent
  • legitimate - legitimate

SetApplicantLabelRequest

  • idinteger · required

    OSApplication ID

  • labelrequired

    Applicant label

    • fraudulent - fraudulent
    • legitimate - legitimate
  • reasonstring

    Explanation for the label

VerifyRequest

  • idinteger · required

    OSApplication ID

TokenObtainPair

  • emailstring · writeOnly · required
  • passwordstring · writeOnly · required
  • accessstring · readOnly · required
  • refreshstring · readOnly · required

GetOrCreateFromURLRequest

  • application_urlstring · uri · required

    ATS application URL

VerificationStatus

  • 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.

JobMinimalPublic

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

PaginatedJobMinimalPublicList

  • 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

EnrichmentExplanation

  • one_linerstring · required
  • banner_iconstring · required
  • banner_icon_textstring · required
  • banner_typestring · required
  • statement_sectionsobject[] · required

Statement

  • statement_textstring · required
  • highlight_for_reviewboolean | null

StatementSection

  • section_titlestring · enum · required
    • Personal Information - Personal Information
    • Company Verification - Company Verification
    • Social Profiles - Social Profiles
    • Resume Analysis - Resume Analysis
    Enum values:
    Personal Information
    Company Verification
    Social Profiles
    Resume Analysis
  • section_display_iconstring · required
  • section_display_typestring · enum · required
    • text-warning - text-warning
    • text-success - text-success
    • text-light - text-light
    • text-black - text-black
    • text-danger - text-danger
    • text-info - text-info
    • text-primary - text-primary
    • text-secondary - text-secondary
    • text-dark - text-dark
    Enum values:
    text-warning
    text-success
    text-light
    text-black
    text-danger
    text-info
    text-primary
    text-secondary
  • auto_expandboolean · required
  • statement_sub_sectionsobject[] · required
  • highlight_for_reviewboolean | null

StatementSectionSectionTitleEnum

string · enum
Enum values:
Personal Information
Company Verification
Social Profiles
Resume Analysis
  • Personal Information - Personal Information
  • Company Verification - Company Verification
  • Social Profiles - Social Profiles
  • Resume Analysis - Resume Analysis

StatementSubSection

  • section_titlestring · enum · required
    • LinkedIn - LinkedIn
    • Github - Github
    • Phone - Phone
    • Email - Email
    • Work Experience - Work Experience
    • Name - Name
    • Metadata - Metadata
    • Resume Clone - Resume Clone
    • LinkedIn Email Lookup - LinkedIn Email Lookup
    • AI Detection - AI Detection
    Enum values:
    LinkedIn
    Github
    Phone
    Email
    Work Experience
    Name
    Metadata
    Resume Clone
  • section_display_iconstring · required
  • section_display_typestring · enum · required
    • text-warning - text-warning
    • text-success - text-success
    • text-light - text-light
    • text-black - text-black
    • text-danger - text-danger
    • text-info - text-info
    • text-primary - text-primary
    • text-secondary - text-secondary
    • text-dark - text-dark
    Enum values:
    text-warning
    text-success
    text-light
    text-black
    text-danger
    text-info
    text-primary
    text-secondary
  • auto_expandboolean · required
  • statementsobject[] · required
  • section_subtitlestring
    Default:
  • highlight_for_reviewboolean | null

StatementSubSectionSectionTitleEnum

string · enum
Enum values:
LinkedIn
Github
Phone
Email
Work Experience
Name
Metadata
Resume Clone
  • LinkedIn - LinkedIn
  • Github - Github
  • Phone - Phone
  • Email - Email
  • Work Experience - Work Experience
  • Name - Name
  • Metadata - Metadata
  • Resume Clone - Resume Clone
  • LinkedIn Email Lookup - LinkedIn Email Lookup
  • AI Detection - AI Detection

AuthTokensResponse

  • access_tokenstring · required
  • refresh_tokenstring · required
  • userobject · required

AuthUser

  • idinteger · required
  • emailstring · email · required
  • first_namestring · required
  • last_namestring · required
  • user_typestring
  • is_new_userboolean

OAuthLoginRequest

  • codestring · required
  • redirect_uristring · required

SectionDisplayTypeEnum

string · enum
Enum values:
text-warning
text-success
text-light
text-black
text-danger
text-info
text-primary
text-secondary
  • text-warning - text-warning
  • text-success - text-success
  • text-light - text-light
  • text-black - text-black
  • text-danger - text-danger
  • text-info - text-info
  • text-primary - text-primary
  • text-secondary - text-secondary
  • text-dark - text-dark

ErrorResponse

  • errorboolean · required

    Always true to indicate an error response.

  • status_codeinteger · required

    HTTP status code for this error.

  • detailstring · required

    Human-readable message explaining the error.

  • error_codestring

    Machine-readable error code identifying the error type.

LogoutRequest

  • refreshstring · required

MessageResponse

  • messagestring · required

EnrichmentTierEnum

string · enum
Enum values:
BASIC
ADVANCED
  • BASIC - BASIC
  • ADVANCED - ADVANCED

RecruiterProvidedLabelEnum

string · enum
Enum values:
NO_USER_LABEL
MARKED_FRAUDULENT
MARKED_LEGITIMATE
  • NO_USER_LABEL - NO_USER_LABEL
  • MARKED_FRAUDULENT - MARKED_FRAUDULENT
  • MARKED_LEGITIMATE - MARKED_LEGITIMATE

ApplicantEmail

  • emailstring · email · required
  • tagstring · enum · required
    • PRIMARY - PRIMARY
    • PERSONAL - PERSONAL
    • WORK - WORK
    Enum values:
    PRIMARY
    PERSONAL
    WORK

ApplicantEmailTagEnum

string · enum
Enum values:
PRIMARY
PERSONAL
WORK
  • PRIMARY - PRIMARY
  • PERSONAL - PERSONAL
  • WORK - WORK

ApplicantIP

  • ip_addressstring · required
  • tagstring · enum · required
    • RESUME_SUBMISSION - RESUME_SUBMISSION
    Enum values:
    RESUME_SUBMISSION
  • collected_atstring | null · date-time

ApplicantIPTagEnum

string · enum
Enum values:
RESUME_SUBMISSION
  • RESUME_SUBMISSION - RESUME_SUBMISSION

ApplicantVerificationRequest

  • namestring · required
  • email_addressesobject[] · required
  • resume_presigned_download_urlstring · uri · required

    URL to download the applicant's resume file for metadata analysis and parsing. We recommend providing this as a presigned URL to a cloud storage location (e.g Amazon S3, Google Cloud Storage, etc ).

  • client_reference_idstring

    Optional client-supplied identifier to correlate results. Typically used for bulk submissions; if omitted in bulk, a UUID will be assigned.

  • linkedin_urlstring | null · uri
  • phone_numbersarray | null

    Optional client-supplied phone numbers for the application. Must conform to E.164 format (e.g., +14155552671). So for US numbers this means including the country code (+1).

  • github_urlstring | null · uri
  • locationstring | null

    Optional client-supplied location string. e.g 'San Francisco, CA'

  • collected_ipsarray | null

BulkItemResult

  • client_reference_idstring · required

    Echo of the client_reference_id provided in the request (or a server-assigned UUID if omitted).

  • statusstring · enum · required
    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
    Enum values:
    SUCCESS
    IN_PROGRESS
    ERROR
    NOT_FOUND
    NOT_ENRICHED
  • resultobject
  • error_codestring
  • error_reasonstring

BulkPollResponse

  • statusstring · enum · required
    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
    Enum values:
    SUCCESS
    IN_PROGRESS
    ERROR
    NOT_FOUND
    NOT_ENRICHED
  • group_idstring · required
  • completedinteger · required
  • totalinteger · required
  • resultsobject[]

BulkSubmitResponse

  • statusstring · enum · required
    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
    Enum values:
    SUCCESS
    IN_PROGRESS
    ERROR
    NOT_FOUND
    NOT_ENRICHED
  • group_idstring · required
  • messagestring · required

BulkVerifyRequest

  • requestsobject[] · required

PollStatusResponse

  • statusstring · enum · required
    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
    Enum values:
    SUCCESS
    IN_PROGRESS
    ERROR
    NOT_FOUND
    NOT_ENRICHED
  • task_idstring · required
  • resultobject
  • error_codestring
  • detailstring

RateLimitStatus

  • limitinteger · required

    Max requests allowed in this window

  • window_size_in_secondsinteger · required

    Length of the rate limit window in seconds

  • usedinteger · required

    Number of requests already used in this window

  • remaininginteger · required

    Number of requests remaining in this window

  • seconds_until_resetinteger · required

    Seconds until the rate limit resets

Section

  • titlestring · enum · required
    • Personal Information - Personal Information
    • Company Verification - Company Verification
    • Social Profiles - Social Profiles
    • Resume Analysis - Resume Analysis
    • Trace - Trace
    Enum values:
    Personal Information
    Company Verification
    Social Profiles
    Resume Analysis
    Trace
  • sub_sectionsobject[] · required
  • highlight_for_reviewboolean · required

SectionTitleEnum

string · enum
Enum values:
Personal Information
Company Verification
Social Profiles
Resume Analysis
Trace
  • Personal Information - Personal Information
  • Company Verification - Company Verification
  • Social Profiles - Social Profiles
  • Resume Analysis - Resume Analysis
  • Trace - Trace

StatementSubSectionTitleEnum

string · enum
Enum values:
LinkedIn
Github
Phone
Email
Work Experience
Name
Metadata
Resume Clone
  • LinkedIn - LinkedIn
  • Github - Github
  • Phone - Phone
  • Email - Email
  • Work Experience - Work Experience
  • Name - Name
  • Metadata - Metadata
  • Resume Clone - Resume Clone
  • LinkedIn Email Lookup - LinkedIn Email Lookup
  • AI Detection - AI Detection
  • IP Analysis - IP Analysis
  • Trace - Trace

SubmitTaskResponse

  • statusstring · enum · required
    • SUCCESS - SUCCESS
    • IN_PROGRESS - IN_PROGRESS
    • ERROR - ERROR
    • NOT_FOUND - NOT_FOUND
    • NOT_ENRICHED - NOT_ENRICHED
    Enum values:
    SUCCESS
    IN_PROGRESS
    ERROR
    NOT_FOUND
    NOT_ENRICHED
  • task_idstring · required
  • messagestring · required
  • rate_limit_statusobject · required

VerificationExplanation

  • one_linerstring · required
  • sectionsobject[] · required

VerificationResult

  • probability_fraudulentnumber · double · required
  • explanationobject · required
  • client_reference_idstring · required

BulkActionPublic

  • 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

BulkVerifyStagesRequest

  • job_idinteger · required

    Job ID

  • stage_idsinteger[] · required

    List of Stage IDs

  • tierrequired

    Enrichment tier to use for verification

    • BASIC - BASIC
    • ADVANCED - ADVANCED

BulkVerifyStagesResponse

  • 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.

CheckBulkVerificationCreditsRequest

  • job_idinteger · required

    Job ID

InsufficientCreditsDetails

  • requested_creditsinteger · required

    Number of credits requested for the operation.

  • available_creditsinteger · required

    Number of credits currently available.

  • detailstring · required

    Human-readable message explaining the error.

InsufficientCreditsResponse

  • successboolean · required

    Always true to indicate an error response.

  • error_codestring · required

    Machine-readable error code identifying the error type.

  • detailobject · required
  • messagestring · required

    Human-readable message describing the error.

PaginatedBulkActionPublicList

  • 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

StageInfo

  • idinteger · required
  • namestring · required
  • num_applicationsinteger · required

TierEnum

string · enum
Enum values:
BASIC
ADVANCED
  • BASIC - BASIC
  • ADVANCED - ADVANCED

VerificationCreditsSummary

  • 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.

JobApplicationslPublic

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

PaginatedJobApplicationslPublicList

  • 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

ApplicationJobPublic

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

BasicResponse

  • 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.

PaginatedApplicationJobPublicList

  • 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