POST api/v1/portals/{portalUid}/customer/candidates

Registers and confirms the candidate in the API Requires a customer role to perform this action for b2b integration

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal uid that this action is being performed under	globally unique identifier	Required

Body Parameters

the candidate registration model

CandidateRegistration

Name	Description	Type	Additional information
Logon	The logon.	string	Required Data type: EmailAddress String length: inclusive between 0 and 255
Password	The password.	string	Required Data type: Password String length: inclusive between 0 and 255
Title	The title.	string	Data type: Text String length: inclusive between 0 and 100
Forename	The forename.	string	Required Data type: Text String length: inclusive between 0 and 100
Surname	The surname.	string	Required Data type: Text String length: inclusive between 0 and 100
OtherNames	The other names.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine1	The address line1.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine2	The address line2.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine3	The address line3.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine4	The address line4.	string	Data type: Text String length: inclusive between 0 and 100
PostCode	The post code.	string	Data type: PostalCode String length: inclusive between 0 and 50
Country	The post code.	string	Data type: Text String length: inclusive between 0 and 100
Telephone	The telephone.	string	Data type: PhoneNumber String length: inclusive between 0 and 100
Mobile	The mobile.	string	Data type: PhoneNumber String length: inclusive between 0 and 100
Position	The candidate employment position.	string	Data type: Text String length: inclusive between 0 and 100
Term	The candidate employment term.	string	Data type: Text String length: inclusive between 0 and 100
EarliestStartDate		date	Data type: DateTime
Company	The company.	globally unique identifier	Required
Industry	The name.	string	Data type: Text String length: inclusive between 0 and 100
Discipline	The discipline.	string	Data type: Text String length: inclusive between 0 and 100
SubDiscipline	The sub discipline.	string	Data type: Text String length: inclusive between 0 and 100
ReferralSource	The candidate referral source	string	Data type: Text String length: inclusive between 0 and 100
DateOfBirth	The candidates dob	date	None.
Nationality	The candidates nationality	string	Data type: Text String length: inclusive between 0 and 100
Gender		string	Data type: Text String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "Logon": "sample string 1",
  "Password": "sample string 2",
  "Title": "sample string 3",
  "Forename": "sample string 4",
  "Surname": "sample string 5",
  "OtherNames": "sample string 6",
  "AddressLine1": "sample string 7",
  "AddressLine2": "sample string 8",
  "AddressLine3": "sample string 9",
  "AddressLine4": "sample string 10",
  "PostCode": "sample string 11",
  "Country": "sample string 12",
  "Telephone": "sample string 13",
  "Mobile": "sample string 14",
  "Position": "sample string 15",
  "Term": "sample string 16",
  "EarliestStartDate": "2025-10-27T14:01:45.0617811+00:00",
  "Company": "9b4c5369-14eb-4f87-8a3f-5c1e0306720b",
  "Industry": "sample string 18",
  "Discipline": "sample string 19",
  "SubDiscipline": "sample string 20",
  "ReferralSource": "sample string 21",
  "DateOfBirth": "2025-10-27T14:01:45.0617811+00:00",
  "Nationality": "sample string 22",
  "Gender": "sample string 23"
}

application/xml, text/xml

Sample:

<CandidateRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AddressLine1>sample string 7</AddressLine1>
  <AddressLine2>sample string 8</AddressLine2>
  <AddressLine3>sample string 9</AddressLine3>
  <AddressLine4>sample string 10</AddressLine4>
  <Company>9b4c5369-14eb-4f87-8a3f-5c1e0306720b</Company>
  <Country>sample string 12</Country>
  <DateOfBirth>2025-10-27T14:01:45.0617811+00:00</DateOfBirth>
  <Discipline>sample string 19</Discipline>
  <EarliestStartDate>2025-10-27T14:01:45.0617811+00:00</EarliestStartDate>
  <Forename>sample string 4</Forename>
  <Gender>sample string 23</Gender>
  <Industry>sample string 18</Industry>
  <Logon>sample string 1</Logon>
  <Mobile>sample string 14</Mobile>
  <Nationality>sample string 22</Nationality>
  <OtherNames>sample string 6</OtherNames>
  <Password>sample string 2</Password>
  <Position>sample string 15</Position>
  <PostCode>sample string 11</PostCode>
  <ReferralSource>sample string 21</ReferralSource>
  <SubDiscipline>sample string 20</SubDiscipline>
  <Surname>sample string 5</Surname>
  <Telephone>sample string 13</Telephone>
  <Term>sample string 16</Term>
  <Title>sample string 3</Title>
</CandidateRegistration>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CandidateViewModel

Name	Description	Type	Additional information
Title	The candidate title.	string	None.
Forename	The candidate forename.	string	None.
Surname	The candidate surname.	string	None.
OtherNames	The candidate other names.	string	None.
AddressLine1	The candidate address line1.	string	None.
AddressLine2	The candidate address line2.	string	None.
AddressLine3	The candidate address line3.	string	String length: inclusive between 0 and 100
AddressLine4	The candidate address line4.	string	None.
PostCode	The candidate post code.	string	None.
Country	The candidate post code.	string	None.
Telephone	The candidate telephone number.	string	None.
Mobile	The candidate mobile telephone number.	string	None.
Email	The candidate email address.	string	None.
Position	The candidate employment position.	string	None.
Term	The candidate employment term.	string	None.
EarliestStartDate	The earliest date a candidate can start work	date	None.
Company	The company to which the candidate is assigned to.	CompanyViewModel	None.
ReferenceNumber	The candidate reference number.	string	None.
PrimaryIndustry	The candidates primary industry (readonly)	string	None.
PrimaryDiscipline	The candidates primary discipline	string	None.
PrimarySubDiscipline	The candidates sub-discipline	string	None.
IsPrimaryIndustryDiscipline	The candidates primary industry discipline	boolean	None.
PersonalStatement	The candidates personal statement	string	None.
Latitude	The candidates latitude	decimal number	None.
Longitude	The candidates longitude	decimal number	None.
ReferralSource	The original referral source of the candidate	string	None.
Gender	The candidates gender recorded in eclipse	string	None.
Location	The candidates current location	string	None.
Area	The candidates area	string	None.
Region	The candidates region	string	None.
EclipseStatus	The candidates status in Eclispe	string	None.
EclipseLastUpdated	The last date/time the candidate was updated in Eclipse	date	None.
ComplianceExpires	The next date that the candidates compliance expires	date	None.
CandidateGuid	The candidate unique identifier	globally unique identifier	None.
DateOfBirth	The candidates date of birth	date	None.
Nationality	The candidates nationality	string	None.
EmploymentSought	The employment sought	string	None.
MinAnnualSalary	The candidates min salary	decimal number	None.
MaxAnnualSalary	The candidates max salary	decimal number	None.
MinHourlyPayrate	The candidates min hourly payrate	decimal number	None.
MaxHourlyPayrate	The candidates max hourly payrate	decimal number	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Forename": "sample string 2",
  "Surname": "sample string 3",
  "OtherNames": "sample string 4",
  "AddressLine1": "sample string 5",
  "AddressLine2": "sample string 6",
  "AddressLine3": "sample string 7",
  "AddressLine4": "sample string 8",
  "PostCode": "sample string 9",
  "Country": "sample string 10",
  "Telephone": "sample string 11",
  "Mobile": "sample string 12",
  "Email": "sample string 13",
  "Position": "sample string 14",
  "Term": "sample string 15",
  "EarliestStartDate": "2025-10-27T14:01:45.0617811+00:00",
  "Company": {
    "Name": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "AddressLine4": "sample string 5",
    "PostCode": "sample string 6",
    "Country": {
      "Iso3Code": "sample string 1",
      "Name": "sample string 2",
      "Portal": {
        "Name": "sample string 1",
        "Uid": "9227178b-f20b-423a-b0d8-5f83c3e2e9fb",
        "Links": [
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          },
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          }
        ],
        "DateUpdated": "2025-10-27T14:01:45.0617811+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "0b6f05da-00f0-4fe5-b46f-7fdfb50e9f8f",
      "Uid": "36a67a07-bede-4955-a8f9-6351145b768b",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-10-27T14:01:45.0617811+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "88d0de96-70e8-4805-890c-f6d22e3b5e29",
    "PortalGuid": "1c8c32dc-c9f0-4448-8c8c-5d2cf9381823",
    "CompanyGuid": "f24c38e2-4c50-4502-a205-6ae7faa1ac22",
    "Uid": "d36704da-eb84-4a79-be67-b0630f7b42ce",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T14:01:45.0617811+00:00",
    "UpdatedBy": "sample string 13"
  },
  "ReferenceNumber": "sample string 16",
  "PrimaryIndustry": "sample string 17",
  "PrimaryDiscipline": "sample string 18",
  "PrimarySubDiscipline": "sample string 19",
  "IsPrimaryIndustryDiscipline": true,
  "PersonalStatement": "sample string 21",
  "Latitude": 1.1,
  "Longitude": 1.1,
  "ReferralSource": "sample string 22",
  "Gender": "sample string 23",
  "Location": "sample string 24",
  "Area": "sample string 25",
  "Region": "sample string 26",
  "EclipseStatus": "sample string 27",
  "EclipseLastUpdated": "2025-10-27T14:01:45.0617811+00:00",
  "ComplianceExpires": "2025-10-27T14:01:45.0617811+00:00",
  "CandidateGuid": "001080ef-c9a2-477c-a266-dfb35af6a6e0",
  "DateOfBirth": "2025-10-27T14:01:45.0617811+00:00",
  "Nationality": "sample string 29",
  "EmploymentSought": "sample string 30",
  "MinAnnualSalary": 31.1,
  "MaxAnnualSalary": 32.1,
  "MinHourlyPayrate": 33.1,
  "MaxHourlyPayrate": 34.1,
  "Uid": "7a9908c9-208d-444b-a802-6a049b1c62d5",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T14:01:45.0617811+00:00",
  "UpdatedBy": "sample string 36"
}

application/xml, text/xml

Sample:

<CandidateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T14:01:45.0617811+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>7a9908c9-208d-444b-a802-6a049b1c62d5</Uid>
  <UpdatedBy>sample string 36</UpdatedBy>
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <AddressLine3>sample string 7</AddressLine3>
  <AddressLine4>sample string 8</AddressLine4>
  <Area>sample string 25</Area>
  <CandidateGuid>001080ef-c9a2-477c-a266-dfb35af6a6e0</CandidateGuid>
  <Company>
    <DateUpdated>2025-10-27T14:01:45.0617811+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>d36704da-eb84-4a79-be67-b0630f7b42ce</Uid>
    <UpdatedBy>sample string 13</UpdatedBy>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <AddressLine3>sample string 4</AddressLine3>
    <AddressLine4>sample string 5</AddressLine4>
    <CompanyGuid>f24c38e2-4c50-4502-a205-6ae7faa1ac22</CompanyGuid>
    <Country>
      <DateUpdated>2025-10-27T14:01:45.0617811+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>36a67a07-bede-4955-a8f9-6351145b768b</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>0b6f05da-00f0-4fe5-b46f-7fdfb50e9f8f</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T14:01:45.0617811+00:00</DateUpdated>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
        </Links>
        <Uid>9227178b-f20b-423a-b0d8-5f83c3e2e9fb</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Latitude>sample string 7</Latitude>
    <Longitude>sample string 8</Longitude>
    <Name>sample string 1</Name>
    <PortalGuid>1c8c32dc-c9f0-4448-8c8c-5d2cf9381823</PortalGuid>
    <PortalUid>88d0de96-70e8-4805-890c-f6d22e3b5e29</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <ComplianceExpires>2025-10-27T14:01:45.0617811+00:00</ComplianceExpires>
  <Country>sample string 10</Country>
  <DateOfBirth>2025-10-27T14:01:45.0617811+00:00</DateOfBirth>
  <EarliestStartDate>2025-10-27T14:01:45.0617811+00:00</EarliestStartDate>
  <EclipseLastUpdated>2025-10-27T14:01:45.0617811+00:00</EclipseLastUpdated>
  <EclipseStatus>sample string 27</EclipseStatus>
  <Email>sample string 13</Email>
  <EmploymentSought>sample string 30</EmploymentSought>
  <Forename>sample string 2</Forename>
  <Gender>sample string 23</Gender>
  <IsPrimaryIndustryDiscipline>true</IsPrimaryIndustryDiscipline>
  <Latitude>1.1</Latitude>
  <Location>sample string 24</Location>
  <Longitude>1.1</Longitude>
  <MaxAnnualSalary>32.1</MaxAnnualSalary>
  <MaxHourlyPayrate>34.1</MaxHourlyPayrate>
  <MinAnnualSalary>31.1</MinAnnualSalary>
  <MinHourlyPayrate>33.1</MinHourlyPayrate>
  <Mobile>sample string 12</Mobile>
  <Nationality>sample string 29</Nationality>
  <OtherNames>sample string 4</OtherNames>
  <PersonalStatement>sample string 21</PersonalStatement>
  <Position>sample string 14</Position>
  <PostCode>sample string 9</PostCode>
  <PrimaryDiscipline>sample string 18</PrimaryDiscipline>
  <PrimaryIndustry>sample string 17</PrimaryIndustry>
  <PrimarySubDiscipline>sample string 19</PrimarySubDiscipline>
  <ReferenceNumber>sample string 16</ReferenceNumber>
  <ReferralSource>sample string 22</ReferralSource>
  <Region>sample string 26</Region>
  <Surname>sample string 3</Surname>
  <Telephone>sample string 11</Telephone>
  <Term>sample string 15</Term>
  <Title>sample string 1</Title>
</CandidateViewModel>