POST Api/Integrations/ApplyWitheRecruiter/{clientId}

Post the candidate with vacancy id, you need to set two headers parameters "Content-Type: application/json" and "X-ApplyWith-Signature: Use Hash-based Message Authentication Code (HMAC) SHA256 hash function on your body with your client secret and encode to Base 64"

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client Id for provided for your integration	globally unique identifier	Required

Body Parameters

Model for the creation of a candidate for a available vacancy

ApplyWithViewModel

Name	Description	Type	Additional information
attachments	The file attachments for the candidate and the application.	Collection of ApplyWithAttachment	None.
candidate	The candidate profile information including the base data and background as structure data.	ApplyWithCandidate	None.
policies	The data security policies that have been accepted by the candidate during the application process on the partner side.	ApplyWithPolicies	None.
vacancy	The vacancy information for creating the application.	ApplyWithVacancy	None.
coverLetter	A cover letter for the application.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "attachments": [
    {
      "classification": "cv",
      "data": "sample string 1",
      "format": "base64",
      "name": "sample string 2"
    },
    {
      "classification": "cv",
      "data": "sample string 1",
      "format": "base64",
      "name": "sample string 2"
    }
  ],
  "candidate": {
    "activities": [
      {
        "from": "2025-11-08",
        "name": "sample string 1",
        "to": "2025-11-08"
      },
      {
        "from": "2025-11-08",
        "name": "sample string 1",
        "to": "2025-11-08"
      }
    ],
    "address": {
      "buildingNumber": "sample string 1",
      "city": "sample string 2",
      "country": "sample string 3",
      "postalCode": "sample string 4",
      "street": "sample string 5"
    },
    "certifications": [
      {
        "from": "2025-11-08",
        "name": "sample string 1",
        "to": "2025-11-08",
        "type": "sample string 2"
      },
      {
        "from": "2025-11-08",
        "name": "sample string 1",
        "to": "2025-11-08",
        "type": "sample string 2"
      }
    ],
    "customFields": [
      {
        "internalName": "sample string 1",
        "values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "internalName": "sample string 1",
        "values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "dateOfBirth": "2025-11-08",
    "educations": [
      {
        "from": "2025-11-08",
        "location": "sample string 2",
        "specialization": "sample string 3",
        "to": "2025-11-08",
        "type": "sample string 4"
      },
      {
        "from": "2025-11-08",
        "location": "sample string 2",
        "specialization": "sample string 3",
        "to": "2025-11-08",
        "type": "sample string 4"
      }
    ],
    "emailAddress": "sample string 1",
    "experience": [
      {
        "company": "sample string 1",
        "from": "2025-11-08",
        "position": "sample string 3",
        "quitReason": "sample string 4",
        "tasks": "sample string 5",
        "to": "2025-11-08"
      },
      {
        "company": "sample string 1",
        "from": "2025-11-08",
        "position": "sample string 3",
        "quitReason": "sample string 4",
        "tasks": "sample string 5",
        "to": "2025-11-08"
      }
    ],
    "firstName": "sample string 2",
    "languages": [
      {
        "level": "basic",
        "name": "sample string 1"
      },
      {
        "level": "basic",
        "name": "sample string 1"
      }
    ],
    "lastName": "sample string 3",
    "mobileNumber": "sample string 4",
    "phoneNumber": "sample string 5",
    "publications": [
      {
        "description": "sample string 1",
        "title": "sample string 2",
        "type": "sample string 3"
      },
      {
        "description": "sample string 1",
        "title": "sample string 2",
        "type": "sample string 3"
      }
    ],
    "salutation": "f",
    "titlesAfterName": "sample string 6",
    "titlesBeforeName": "sample string 7",
    "website": "http://webapihelppage8.com"
  },
  "policies": {
    "consent": {
      "accepted": true,
      "id": 1
    },
    "information": {
      "accepted": true,
      "id": 1
    }
  },
  "vacancy": {
    "id": 1
  },
  "coverLetter": "sample string 1"
}

application/xml, text/xml

Sample:

<ApplyWithViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePunkt.Api.Server.Requests.Integrations.ApplyWith">
  <ApplicationId>3</ApplicationId>
  <Attachments>
    <ApplyWithAttachment>
      <Classification>Cv</Classification>
      <Data>sample string 1</Data>
      <Format>Base64</Format>
      <Name>sample string 2</Name>
    </ApplyWithAttachment>
    <ApplyWithAttachment>
      <Classification>Cv</Classification>
      <Data>sample string 1</Data>
      <Format>Base64</Format>
      <Name>sample string 2</Name>
    </ApplyWithAttachment>
  </Attachments>
  <Candidate>
    <Activities>
      <ApplyWithActivity>
        <From>2025-11-08T08:12:35.6917838+01:00</From>
        <Name>sample string 1</Name>
        <To>2025-11-08T08:12:35.6917838+01:00</To>
      </ApplyWithActivity>
      <ApplyWithActivity>
        <From>2025-11-08T08:12:35.6917838+01:00</From>
        <Name>sample string 1</Name>
        <To>2025-11-08T08:12:35.6917838+01:00</To>
      </ApplyWithActivity>
    </Activities>
    <Address>
      <BuildingNumber>sample string 1</BuildingNumber>
      <City>sample string 2</City>
      <Country>sample string 3</Country>
      <PostalCode>sample string 4</PostalCode>
      <Street>sample string 5</Street>
    </Address>
    <Certifications>
      <ApplyWithCertification>
        <From>2025-11-08T08:12:35.6917838+01:00</From>
        <Name>sample string 1</Name>
        <To>2025-11-08T08:12:35.6917838+01:00</To>
        <Type>sample string 2</Type>
      </ApplyWithCertification>
      <ApplyWithCertification>
        <From>2025-11-08T08:12:35.6917838+01:00</From>
        <Name>sample string 1</Name>
        <To>2025-11-08T08:12:35.6917838+01:00</To>
        <Type>sample string 2</Type>
      </ApplyWithCertification>
    </Certifications>
    <CustomFields>
      <ApplyWithCustomField>
        <InternalName>sample string 1</InternalName>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </ApplyWithCustomField>
      <ApplyWithCustomField>
        <InternalName>sample string 1</InternalName>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </ApplyWithCustomField>
    </CustomFields>
    <DateOfBirth>2025-11-08T08:12:35.7073331+01:00</DateOfBirth>
    <Educations>
      <ApplyWithEducation>
        <From>2025-11-08T08:12:35.7073331+01:00</From>
        <Location>sample string 2</Location>
        <MandatorId>5</MandatorId>
        <Specialization>sample string 3</Specialization>
        <To>2025-11-08T08:12:35.7073331+01:00</To>
        <Type>sample string 4</Type>
      </ApplyWithEducation>
      <ApplyWithEducation>
        <From>2025-11-08T08:12:35.7073331+01:00</From>
        <Location>sample string 2</Location>
        <MandatorId>5</MandatorId>
        <Specialization>sample string 3</Specialization>
        <To>2025-11-08T08:12:35.7073331+01:00</To>
        <Type>sample string 4</Type>
      </ApplyWithEducation>
    </Educations>
    <EmailAddress>sample string 1</EmailAddress>
    <Experience>
      <ApplyWithExperience>
        <Company>sample string 1</Company>
        <From>2025-11-08T08:12:35.7073331+01:00</From>
        <Position>sample string 3</Position>
        <QuitReason>sample string 4</QuitReason>
        <Tasks>sample string 5</Tasks>
        <To>2025-11-08T08:12:35.7073331+01:00</To>
      </ApplyWithExperience>
      <ApplyWithExperience>
        <Company>sample string 1</Company>
        <From>2025-11-08T08:12:35.7073331+01:00</From>
        <Position>sample string 3</Position>
        <QuitReason>sample string 4</QuitReason>
        <Tasks>sample string 5</Tasks>
        <To>2025-11-08T08:12:35.7073331+01:00</To>
      </ApplyWithExperience>
    </Experience>
    <FirstName>sample string 2</FirstName>
    <Languages>
      <ApplyWithLanguage>
        <Level>Basic</Level>
        <Name>sample string 1</Name>
      </ApplyWithLanguage>
      <ApplyWithLanguage>
        <Level>Basic</Level>
        <Name>sample string 1</Name>
      </ApplyWithLanguage>
    </Languages>
    <LastName>sample string 3</LastName>
    <MobileNumber>sample string 4</MobileNumber>
    <PhoneNumber>sample string 5</PhoneNumber>
    <Publications>
      <ApplyWithPublication>
        <Description>sample string 1</Description>
        <Title>sample string 2</Title>
        <Type>sample string 3</Type>
      </ApplyWithPublication>
      <ApplyWithPublication>
        <Description>sample string 1</Description>
        <Title>sample string 2</Title>
        <Type>sample string 3</Type>
      </ApplyWithPublication>
    </Publications>
    <Referrer>sample string 9</Referrer>
    <Salutation>F</Salutation>
    <TitlesAfterName>sample string 6</TitlesAfterName>
    <TitlesBeforeName>sample string 7</TitlesBeforeName>
    <Website>http://webapihelppage8.com/</Website>
  </Candidate>
  <CandidateId>2</CandidateId>
  <CoverLetter>sample string 1</CoverLetter>
  <HasCreatedWithSuccess>true</HasCreatedWithSuccess>
  <Policies>
    <Consent>
      <Accepted>true</Accepted>
      <Id>1</Id>
    </Consent>
    <Information>
      <Accepted>true</Accepted>
      <Id>1</Id>
    </Information>
  </Policies>
  <Vacancy>
    <Id>1</Id>
  </Vacancy>
</ApplyWithViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The applicant/candidate Id and the application Id

ApplyWithResponse

Name	Description	Type	Additional information
ApplicantId		integer	None.
ApplicationId		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ApplicantId": 1,
  "ApplicationId": 2
}

application/xml, text/xml

Sample:

<ApplyWithResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses.Integrations">
  <ApplicantId>1</ApplicantId>
  <ApplicationId>2</ApplicationId>
</ApplyWithResponse>