API docs by Redocly

MatchFT API (1.0)

Download OpenAPI specification:

The documentation of MatchFT API services.

Job Seeker

Upsert Job Seeker in order to match with offers

Request Body schema: application/json
required
updatedAt
required
string <date-time>
required
Array of objects (Experience)
id
required
string
encryptedFirstName
required
string
encryptedLastName
required
string
encryptedPhoneNumber
required
string
office
required
string
officeCode
required
string
profile
required
string
consentToSmsReception
required
boolean
consentToEmailReception
required
boolean
required
Array of objects (DesiredJob)
required
Array of objects (Training)
required
Array of objects (LanguageLevel)
required
Array of objects (License)
skills
required
Array of strings
availabilityScore
required
number

Responses

Request samples

Content type
application/json
{
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "experiences": [
    ],
  • "id": "string",
  • "encryptedFirstName": "string",
  • "encryptedLastName": "string",
  • "encryptedPhoneNumber": "string",
  • "office": "string",
  • "officeCode": "string",
  • "profile": "string",
  • "consentToSmsReception": true,
  • "consentToEmailReception": true,
  • "desiredJobs": [
    ],
  • "trainings": [
    ],
  • "languagesLevel": [
    ],
  • "licenses": [
    ],
  • "skills": [
    ],
  • "availabilityScore": 0
}

CSV Upload

Upsert Job Seekers in CSV format

query Parameters
tarGz
boolean
fileName
string
Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Upsert Offers in CSV format

query Parameters
tarGz
boolean
fileName
string
Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Upsert Offers / Job Seeker connections in CSV format

Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Offer

Upsert Offer in order to match with job seekers

Request Body schema: application/json
required
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
validationDate
required
string or null <date-time>
id
required
string
state
required
string
stateLabel
required
string
topoffrepartenaireaom
required
boolean
screeningMode
required
string
screeningModeLabel
required
string
unitesuivi
required
number
romeId
required
string
romeLabel
required
string
romeDescriptionId
required
string
romeDescriptionLabel
required
string
title
required
string
description
required
string
initialOpenPositions
required
number
remainingOpenPositions
required
number
required
Array of objects or null (Language)
required
Array of objects or null (License)
duration
required
number or null
durationUnit
required
string or null
durationUnitLabel
required
string or null
contractType
required
string
contractTypeLabel
required
string
contractSummary
required
string
requiredExperience
required
number or null
requiredExperienceUnit
required
string or null
requiredExperienceComment
required
string or null
requiredExperienceSummary
required
string
minimumWage
required
number or null
maximumWage
required
number or null
durationMonth
required
number or null
wageComment
required
string or null
wageTypeLabel
required
string
required
Array of objects or null (AdditionalPay)
wageSummary
required
string or null
businessTripFrequencyLabel
required
string or null
businessTripType
required
string or null
workingConditionsSummary
required
string or null
scheduleTypeLabel
required
string or null
scheduleTypeDetail
required
string or null
lblconditionexercice
required
string
weeklyWorkedHours
required
number
weeklyWorkedMinutes
required
number or null
isPartTime
required
boolean
scheduleSummary
required
string
required
Array of objects or null (Skill)
required
Array of objects or null (Task)
required
Array of objects or null (SkillFreeText)
softSkills
required
Array of strings or null
required
Array of objects or null (Training)
locationLabel
required
string
zipCode
required
string or null
cityZipCode
required
string or null
cityLabel
required
string or null
departmentCode
required
string or null
departmentLabel
required
string or null
regionCode
required
string or null
regionLabel
required
string or null
countryLabel
required
string
topfrontalierlieutravail
required
boolean
locationSummary
required
string
latitude
required
number or null
longitude
required
number or null
siret
required
string or null
companyDescription
required
string or null
companyName
required
string
subClassNAF
required
string
subClassNAFLabel
required
string
companySummary
required
string or null

Responses

Request samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "validationDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "state": "string",
  • "stateLabel": "string",
  • "topoffrepartenaireaom": true,
  • "screeningMode": "string",
  • "screeningModeLabel": "string",
  • "unitesuivi": 0,
  • "romeId": "string",
  • "romeLabel": "string",
  • "romeDescriptionId": "string",
  • "romeDescriptionLabel": "string",
  • "title": "string",
  • "description": "string",
  • "initialOpenPositions": 0,
  • "remainingOpenPositions": 0,
  • "languages": [
    ],
  • "licenses": [
    ],
  • "duration": 0,
  • "durationUnit": "string",
  • "durationUnitLabel": "string",
  • "contractType": "string",
  • "contractTypeLabel": "string",
  • "contractSummary": "string",
  • "requiredExperience": 0,
  • "requiredExperienceUnit": "string",
  • "requiredExperienceComment": "string",
  • "requiredExperienceSummary": "string",
  • "minimumWage": 0,
  • "maximumWage": 0,
  • "durationMonth": 0,
  • "wageComment": "string",
  • "wageTypeLabel": "string",
  • "additionalPays": [
    ],
  • "wageSummary": "string",
  • "businessTripFrequencyLabel": "string",
  • "businessTripType": "string",
  • "workingConditionsSummary": "string",
  • "scheduleTypeLabel": "string",
  • "scheduleTypeDetail": "string",
  • "lblconditionexercice": "string",
  • "weeklyWorkedHours": 0,
  • "weeklyWorkedMinutes": 0,
  • "isPartTime": true,
  • "scheduleSummary": "string",
  • "skills": [
    ],
  • "tasks": [
    ],
  • "skillsFreeText": [
    ],
  • "softSkills": [
    ],
  • "trainings": [
    ],
  • "locationLabel": "string",
  • "zipCode": "string",
  • "cityZipCode": "string",
  • "cityLabel": "string",
  • "departmentCode": "string",
  • "departmentLabel": "string",
  • "regionCode": "string",
  • "regionLabel": "string",
  • "countryLabel": "string",
  • "topfrontalierlieutravail": true,
  • "locationSummary": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "siret": "string",
  • "companyDescription": "string",
  • "companyName": "string",
  • "subClassNAF": "string",
  • "subClassNAFLabel": "string",
  • "companySummary": "string"
}

Expose offer computed criteria with suggested values

path Parameters
offerId
required
string

Responses

Response samples

Content type
application/json
{
  • "criteria": [
    ],
  • "firstMessage": "string"
}

Matching qualification

Starts a session to qualify job seekers following the given criteria with MatchFT matching

path Parameters
offerId
required
string
Request Body schema: application/json
required
required
Array of objects (MatchingJobSeeker) non-empty
criterionCodes
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "jobSeekers": [
    ],
  • "criterionCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "failures": [
    ]
}

Expose offer qualification details about job seekers

path Parameters
offerId
required
string
Request Body schema: application/json
required
profileType
required
string
Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus
required
string
Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
agencyCode
string
required
object (OfferQualificationDetailsPagination)

Responses

Request samples

Content type
application/json
{
  • "profileType": "ALL",
  • "qualificationStatus": "ALL",
  • "agencyCode": "string",
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "jobSeekers": [
    ],
  • "totalJobSeekers": 0,
  • "ready": true
}

Expose IDs of job seeker matching an offer

path Parameters
offerId
required
string
Request Body schema: application/json
required
profileType
required
string
Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus
required
string
Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
agencyCode
string
required
object (OfferQualificationDetailsPagination)

Responses

Request samples

Content type
application/json
{
  • "profileType": "ALL",
  • "qualificationStatus": "ALL",
  • "agencyCode": "string",
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "jobSeekerIds": [
    ]
}

Expose offer job seekers counters and qualified job seekers counters

path Parameters
offerId
required
string
Request Body schema: application/json
required
profileType
required
string
Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus
required
string
Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"

Responses

Request samples

Content type
application/json
{
  • "profileType": "ALL",
  • "qualificationStatus": "ALL"
}

Response samples

Content type
application/json
{
  • "jobSeekerCounters": [
    ],
  • "qualificationCounters": [
    ]
}

Qualification

Expose offer IDs with completed qualification within a given time range

Request Body schema: application/json
required
startDate
required
string <date-time>
endDate
required
string <date-time>
statuses
required
Array of strings
Items Enum: "VALIDATED" "PARTIALLY_VALIDATED" "NOT_VALIDATED" "NO_ANSWER"

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "statuses": [
    ]
}

Response samples

Content type
application/json
{
  • "offerIds": [
    ]
}

Expose job seekers qualification details

path Parameters
offerId
required
string
Request Body schema: application/json
required
qualificationStatus
required
string
Enum: "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
jobSeekerIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "qualificationStatus": "ALL_QUALIFICATIONS",
  • "jobSeekerIds": [
    ]
}

Response samples

Content type
application/json
{
  • "jobSeekers": [
    ]
}

Expose the detail of a job seeker qualification conversation 

Returns the qualification of a single job seeker on a single offer: its status, its dates, the
whole message history, the criteria with their current status, and whether the conversation needs
an advisor's attention along with the reasons why.

The end date is only published three hours after the conversation completed. The attention
reasons and the synthesis are null as long as the conversation has not been analysed.
path Parameters
offerId
required
string

Identifier of the offer

jobSeekerId
required
string

Identifier of the job seeker

Responses

Response samples

Content type
application/json
{
  • "status": "ONGOING",
  • "attentionReasons": [
    ],
  • "offerId": "string",
  • "jobSeekerId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "attentionNeeded": true,
  • "critical": true,
  • "messages": [
    ],
  • "criteria": [
    ],
  • "synthesis": "string"
}

Expose offer qualification counters

path Parameters
offerId
required
string
Request Body schema: application/json
required
profileType
required
string
Enum: "ALL" "REGISTERED" "POOL" "AGENCY"
qualificationStatus
required
string
Enum: "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED"

Responses

Request samples

Content type
application/json
{
  • "profileType": "ALL",
  • "qualificationStatus": "ALL_QUALIFICATIONS"
}

Response samples

Content type
application/json
{
  • "jobSeekerCounters": [
    ],
  • "qualificationCounters": [
    ]
}

Expose job seekers IDs matching the given qualification status

path Parameters
offerId
required
string
Request Body schema: application/json
required
qualificationStatus
required
string
Enum: "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED"
profileType
required
string
Enum: "ALL" "REGISTERED" "POOL" "AGENCY"

Responses

Request samples

Content type
application/json
{
  • "qualificationStatus": "ALL_QUALIFICATIONS",
  • "profileType": "ALL"
}

Response samples

Content type
application/json
{
  • "jobSeekerIds": [
    ]
}

Starts a session to qualify job seekers following the given criteria without MatchFT matching

path Parameters
offerId
required
string
Request Body schema: application/json
required
matchingSource
required
string
Enum: "SDR" "AGLAE"
required
Array of objects (JobSeeker) non-empty
criterionCodes
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "matchingSource": "SDR",
  • "jobSeekers": [
    ],
  • "criterionCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "failures": [
    ]
}

Finds the offer IDs with qualification sessions, among the given offer IDs

Request Body schema: application/json
required
offerIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "offerIds": [
    ]
}

Response samples

Content type
application/json
{
  • "offerIds": [
    ]
}

Expose offers qualifications summary for the given offer IDs

Request Body schema: application/json
required
offerIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "offerIds": [
    ]
}

Response samples

Content type
application/json
{
  • "offers": [
    ]
}

Decline a job seeker qualification on an offer 

Records that the advisor does not follow up on this job seeker for this offer. The decision
carries no payload: the offer and the job seeker are the whole input, and a successful call
answers a 201 with an empty body.

NOT IMPLEMENTED YET: this endpoint currently answers a 501 stating so, whatever the
parameters. The responses below are the contract it will honour once implemented.
path Parameters
offerId
required
string

Identifier of the offer

jobSeekerId
required
string

Identifier of the job seeker

Responses

Expose qualifications for given offers, advisors, agencies, teams 

Returns validated or partially validated qualification or qualification that needs attention, matching the given filters

At least one filter must be sent: a request carrying none of them — every filter absent or
empty — is answered with an empty list rather than with every qualification.
Only qualifications less than 100 days old are considered.
Request Body schema: application/json
required
agencyCodes
Array of strings[ items/^\d+$/ ]
teamCodes
Array of strings
advisorIds
Array of strings
offerIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "agencyCodes": [
    ],
  • "teamCodes": [
    ],
  • "advisorIds": [
    ],
  • "offerIds": [
    ]
}

Response samples

Content type
application/json
{
  • "qualifications": [
    ]
}

Augmented Matching

Expose offer augmented matching and qualification details about job seekers

path Parameters
offerId
required
string
Request Body schema: application/json
required
matchingSource
required
string
Value: "SDR"
qualificationStatus
required
string
Enum: "ALL" "ALL_QUALIFICATIONS" "ONGOING" "VALIDATED" "NOT_VALIDATED" "NO_ANSWER" "PARTIALLY_VALIDATED" "PREQUALIFIABLE"
required
Array of objects (OfferAugmentedMatchingInput)

Responses

Request samples

Content type
application/json
{
  • "matchingSource": "SDR",
  • "qualificationStatus": "ALL",
  • "jobSeekers": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "jobSeekers": [
    ]
}

Experimental

Expose knowledge extracted from conversations with job seekers

path Parameters
offerId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get aggregated knowledge for a specific job seeker

Retrieves comprehensive knowledge about a job seeker, including their criteria responses, conversation analysis, and various aspects of their job search preferences and history.

path Parameters
jobSeekerId
required
string

The unique identifier of the job seeker

Responses

Response samples

Content type
application/json
[
  • {
    }
]