Partner API

Candidate Intelligence API

Allow your users to run Candidate Intelligence reports from within existing candidate profiles - no context switching required.

Request API access

What the API does

Allow your users to run Candidate Intelligence reports from within existing candidate profiles - no context switching required.

Integration flow

Get approved and receive an API key

Request access from TieTalent. Once approved, you receive a partner API key tied to your platform ID.

Add a button inside candidate profiles

Add a Background check button next to candidate names. Once a report exists, it changes to View background check.

Call the TieTalent API when clicked

Send candidate data along with your platform ID, client company ID, and candidate ID.

TieTalent generates or retrieves the report

If a report already exists for this client and candidate, it is returned instantly at no cost.

Display the report in the candidate profile

Render the structured JSON in a collapsible section. Closing and reopening uses the cached report - no new scan.

Report reuse logic

Reports are uniquely identified by platform + company + candidate.

♻️Same client company + same candidate → existing report returned instantly, no charge

🆕Different client company + same candidate → new report generated and billed separately

🆕Same client company + different candidate → new report generated and billed

🛡️Approval required

Authentication

All requests require a partner API key in the X-Partner-Key header.

Approval required. API keys are issued only to approved partner platforms.

http

X-Partner-Key: pk_your_partner_api_key_here
Content-Type: application/json

Example request

POST/api/partner/v1/background-check

json

{
  "partner_platform_id": "your_platform_id",
  "partner_company_id": "client_company_123",
  "partner_candidate_id": "candidate_456",
  "candidate": {
    "full_name": "Jane Smith",
    "location": "London, UK",
    "current_title": "Software Engineer",
    "current_company": "Example Company",
    "cv_text": "...",
    "linkedin_url": "https://linkedin.com/in/example"
  }
}

Example response

json

{
  "report_id": "rpt_abc123",
  "status": "generated",
  "report": {
    "candidate_name": "Jane Smith",
    "hiring_recommendation": {
      "decision": "GO with validation",
      "confidence": "Medium"
    },
    "strengths": ["..."],
    "what_to_validate": ["..."]
  },
  "billing": {
    "charged": true,
    "credits_used": 1
  }
}

Recommended partner UI

No report existsShow: Background check

Report generatingShow: Generating… with loading indicator

Report readyShow: View background check - opens cached report

Privacy & security

Reports are decision-support tools. They must not be used as the sole basis for any hiring decision.

✓

Partner data is fully isolated - you cannot access reports from other partner platforms.

✓

Reports are scoped by partner platform + client company + candidate.

✓

Raw CV text is processed in memory and is not stored unless required by contract.

✓

Data is stored in EU-region infrastructure.

Partner program

Start integrating Candidate Intelligence

Request access and we will activate your partner API credentials. Integration typically takes less than a day.

Request API access Contact partnerships