Alfa

Candidates

Get a link to a candidate's resume

GET/v1/integration/candidates/{candidateId}/resume

A fresh signed link to the resume PDF, valid for 15 minutes. A candidate without a resume, such as a sourced one, is 404 `resume_not_available`. Requires an API key with the `candidates:read` scope.

Requires an Alfa API key as a bearer token. How API keys work

Path parameters

  • candidateIdstringrequired

    Alfa's id for the candidate: `app_…` or `src_…`.

    at least 1 characters · at most 40 characters

Headers

  • Alfa-Company-Idstring

    The Company ID of the company to act for. Required with a platform key, and that company must have authorized your platform; a company key acts for its own company and can leave it out.

Response body

  • urlstringrequired

    A signed link to the resume PDF.

  • expiresAtstringrequired

    When the link stops working: 15 minutes after the request.

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details