This API document is intended for developers who wish to write client applications that interact with the new eFinancialCareers Resume API. It provides a series of examples of API interactions in the form of RESTful requests.


This document does not rely on any particular programming language; your client application can interact with the API using any language that lets you issue HTTP requests and parse XML-based responses.

Before you begin

This section defines important terms and concepts introduced to our new resume API that are necessary to help your clients get the most from their account setup.


We would recommend that this section is read before performing your very first resume search to understand how we have defined teams and resume licenses and how this affects a resume search. This is all explained below along with some real life examples.

Please note, the entities described below are created for our clients by our Client Service team therefore; if you are already searching resumes on behalf of our clients and have contacted us for an API key, you will be able to proceed with the rest of this guide.

Resume Licenses

A recruiter’s account should belong to a resume license to have the possibility of resume searching. Resume licenses are restricted by a location (by country, region or they may be global). A company can have multiple Resume Licenses with the same start and end date with the same level access and the same Location level, e.g. regional, global. A company can have multiple Resume Licenses running at the same time, but only one license can be assigned to the user simultaneously. Each resume license has fixed number of available views per certain period of time.


There are two types of resume licenses:

  1. Resume License with Monthly Access
  2. Resume License with Fixed Period Access

Resume Views

A recruiter must be a member of an active resume license if viewing a resume for the first time. A resume view count is used when a recruiter is viewing a resume that they have never viewed before and the team (“resume license team”) they are in has never had a member that viewed that resume (whilst belonging to that team). A recruiter who no longer has a resume license but has an active contract, then he should not be able to view the CVs unless they are saved in his saved resume folder. The candidate’s location or willing to relocate location(s) must fall within the restriction of user’s resume database license when the resume is viewed.

Scenario: A recruiter is part of a resume licence which can only view UK resumes. This recruiter has viewed resumes from the UK for several weeks. This recruiter has requested to view resumes in France only so Client Services change the licence to France only. – This recruiter will no longer be able to view resumes from the UK, however, they must be able to view resumes they have previously viewed from the UK.

Scenario: A recruiter saves resume 123 and their database licence has expired but still have an active contract with us. If the candidate updates their resume 123 with an updated word document then the recruiter will be able to view this resume and not be deducted a view credit.

If a user has a resume in their marked resumes, and they view that resume via their marked resumes their team is not charged with a credit. Any user within a team can view a resume for free, if a member of that team has already viewed that resume within the last 30 days (this number would be configurable). If a user moves teams, they would be able to view any resume that was viewed by a member of the team they moved to over the last 30 days, without incurring a cost. If a user moves teams, the team the user has moved to would not inherit any free resume views from the user who moved. A user who has moved from one team to another would lose free access to their previous views unless they view the resume through their marked resumes. If a team member views a resume more than 30 days after its last view incurred a cost, the team would be charged a credit.