v1

latestOpenAPI 3.0.1MIT2026-07-2691084.8 KB

Creates or update a profile and job application

Save a new job application in Jarvi. It creates the profile if it does not exist, upload the file, link the profile to the recruitment project,...

post/rest/v2/applicants

Request body

referenceIdstring

The reference id of the job application. If provided, Jarvi will associate the profile to the right recruitment project

projectIdstring

(rarely used) As for the reference id, but with the Jarvi internal project id. You can use projectId, referenceId or none of them if you want to create a profile without linking it to a project

firstNamestring

If not provided, will be extracted from the resume or Linkedin URL. If no resume or Linkedin URL, will be required

lastNamestring

If not provided, will be extracted from the resume or Linkedin URL. If no resume or Linkedin URL, will be required

emailAddressesstring

Multiple email addresses separated by a comma. If not provided, will be extracted from the resume or Linkedin URL.

phoneNumbersstring

Multiple phone numbers separated by a comma. If not provided, will be extracted from the resume or Linkedin URL.

linkedinUrlstring

The linkedin URL of the profile. If provided, Jarvi will extract the profile informations from the linkedin profile

historyEntrySubjectstring

The subject of the historyentry you want to show in the profile’s Jarvi history. If not provided, will be "Candidature depuis formulaire web"

historyEntryMessagestring

The message of the historyentry you want to show in the profile’s Jarvi history

externalIdstring

(rarely used) Your id. Will merge with exisiting profile with same externalId

idstring

(rarely used) Jarvi uuid. Will merge with exisiting profile with same id

locationstring

The location of the profile. If not provided, will be extracted from the resume or Linkedin URL

headlinestring

The headline of the profile. If not provided, will be extracted from the resume or Linkedin URL

currentCompanyNamestring

The current company name of the profile. If not provided, will be extracted from the resume or Linkedin URL. If a company with this name exists, the profile will be associated as contact of this company

currentCompanyIdstring

If a company with this id exists, the profile will be associated as contact of this company

currentPositionstring

The current job title of the profile. If not provided, will be extracted from the resume or Linkedin URL

<any custom field uuid>string

Any custom field you want to add to the profile. You can find the uuid of the custom field in the Jarvi settings. If you want to provide multiple values, you can separate them with a comma

Example request

{
  "referenceId": "JARVI001",
  "projectId": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
  "firstName": "Quentin",
  "lastName": "Decré",
  "emailAddresses": "quentin@jarvi.tech, quentin@decre.tech",
  "phoneNumbers": "+33752626164,0240493773",
  "linkedinUrl": "https://www.linkedin.com/in/quentindecre/",
  "historyEntrySubject": "Application from website",
  "historyEntryMessage": "The message of the historyentry you want to show in the profile’s Jarvi history",
  "resumesFiles": [
    {
      "fileName": "cv.pdf",
      "data": "data:@file/pdf;base64,JVBERi0......AABTLAAAAAA="
    }
  ],
  "files": [
    {
      "fileName": "motivation.docx",
      "data": "data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA="
    }
  ],
  "externalId": "Your id. Will merge with exisiting profile with same externalId",
  "id": "Jarvi uuid. Will merge with exisiting profile with same id",
  "location": "Rennes, France",
  "headline": "Co-Founder Jarvi",
  "currentCompanyName": "Jarvi",
  "currentCompanyId": "Jarvi",
  "currentPosition": "Co-founder",
  "<any custom field uuid>": "My custom field value for this profile"
}

Response

The application has been saved

messagestring

taskIdstring

profileIdstring

Example response

{
  "message": "Profile saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "profileId": "d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"
}

All 9 operations