Skip to main content

Extract candidate details

POST 

/candidates/extract

Step 1 of 2. Upload up to 10 CVs for one job and get back the details Tarkflo read from each file.

Nothing is saved to the pipeline. No candidate, application or email is created. The response is a draft for you or your user to review. Drop the rows you do not want, fix the ones that are wrong, then send the rest to Submit candidates.

Extraction reads identity only: name, email and phone. It does not return skills, work history or a score.

Each uploaded file gets exactly one entry in extractions, in upload order, so index always matches the position of the file you sent. A bad file never fails the whole request. It comes back with a non-ok status and a message.

Each entry also lists any existing candidates in your workspace that share the email or phone, so duplicates are your decision, made with the evidence in front of you. A duplicate shows the existing candidate's ID and name, never their email or phone, so a phone match cannot reveal someone else's email.

The stored CV is referenced by cv_id. A cv_id that is not submitted within 24 hours is deleted and stops working. A cv_id attaches to one candidate only. If that candidate cannot be added, the cv_id is given back and you can use it again.

Files must be PDF, DOC or DOCX, up to 5 MB each. The role this key acts as needs the candidates:create permission.

Request​

Responses​

One extraction per uploaded file.

Response Headers
    X-RateLimit-Limit

    Requests allowed in the current window for this key.

    X-RateLimit-Remaining

    Requests left in the current window.