Retrieve candidate CVs

You can retrieve your candidates' CV(s) using the API.

Request

This method allows you to retrieve your candidates' CV(s):

GET /company/{companyID}/files/expire?key={CV_key}&extension={CV_extension}&token={API_key}

To retrieve candidate CVs you will need:

• your API key (or token)
• the CV key
• the CV extension

The CV key and extension can be retrieved in different ways:

• via the "new candidate" webhook in the "cv" property
• via candidate retrieval

Important

The API key is valid for 365 days and expires automatically. We trigger an alert 15 days before expiration. You can create your API key and find this information at: https://app.flatchr.io/board/settings/advanced/api

Rate limiting

This API route is subject to a rate limit of 1 request per second per company.

If multiple requests are sent for the same company within less than one second, excess requests may be rejected with an HTTP 429 Too Many Requests response.

We recommend that API clients:

• limit their calls to 1 request per second per company;
• implement a retry strategy with backoff when receiving a 429 response;
• avoid concurrent calls for the same company on this route.

Example via the "new candidate" webhook

"cv": {
  "fileable_id": 3935678,
  "fileable_type": "candidates",
  "id": 3929083,
  "url": "flatchr.s3.eu-west-1.amazonaws.com/candidates/2024/01/c18f5238-a774-4609-8d59-f022a8f781db/ivern-elsa.pdf",
  "key": "candidates/2024/01/c18f5238-a774-4609-8d59-f022a8f781db/ivern-elsa",
  "type": "CV",
  "created_at": "2023-12-12T15:58:43.942Z",
  "updated_at": "2024-01-09T12:23:39.544Z",
  "extension": "pdf"
}

Parameters

Parameter	In	Type	Required	Description	Example
companyId	path	string	✔️	Company identifier	Wy3EOp2NP3p1KMq8
key	query	string	✔️	Unique CV key available via webhook	candidates/2024/01/c18f5238-a774-4609-8d59-f022a8f781db/ivern-elsa
extension	query	string	✔️	Document extension	pdf
token	query	string	✔️	Token to access the API	xxxxxxxxxx

Request example

curl -X GET https://api.flatchr.io/company/2zNDRr9BMnYqXyEK/files/expire?key=candidates/2024/01/c18f5238-a774-4609-8d59-f022a8f781db/ivern-elsa&extension=pdf&token=XXXXXXX