PUT api/v1/candidates/compliance/{candidateComplianceUid}

Updates the candidate compliance.

Request Information

URI Parameters

Name	Description	Type	Additional information
candidateComplianceUid	The candidate compliance UID.	globally unique identifier	Required

Body Parameters

The candidate compliance.

CandidateCompliance

Name	Description	Type	Additional information
Name	The candidate compliance name.	string	Required String length: inclusive between 0 and 100
IsApproved	True if the candidate compliance is approved; otherwise, false.	boolean	None.

Name

Description

Type

Additional information

Name

The candidate compliance name.

string

Required

String length: inclusive between 0 and 100

IsApproved

True if the candidate compliance is approved; otherwise, false.

boolean

None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "IsApproved": true
}

application/xml, text/xml

Sample:

<CandidateCompliance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <IsApproved>true</IsApproved>
  <Name>sample string 1</Name>
</CandidateCompliance>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns candidate compliance details.

CandidateComplianceViewModel

Name	Description	Type	Additional information
Name	The candidate compliance name.	string	None.
IsApproved	true if this instance is approved; otherwise, false.	boolean	None.
Candidate	The candidate.	CandidateViewModel	None.
Expires	The date that this compliance item expires	date	None.
Status	The current compliance status	string	None.
Reference	The reference for this compliance item	string	None.
IssueDate	Date the compliance item as issued	date	None.
ApprovedDate	Date the compliance item was approved	date	None.
ApprovedBy	Who approved the compliance item	string	None.
Expired	Has the compliance item expired	boolean	None.
Notes	Additional notes	string	None.
ComplianceGuid	The compliance item guid	globally unique identifier	None.
Heading	The heading this compliance item falls under	string	None.
HeadingDescription	The heading descriptiopn	string	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:

{
  "Name": "sample string 1",
  "IsApproved": true,
  "Candidate": {
    "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-27T13:59:53.687435+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": "f1a66c94-e81a-4474-978e-2caa7328c5c5",
          "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-27T13:59:53.687435+00:00",
          "UpdatedBy": "sample string 3"
        },
        "CountryGuid": "3485ce72-fe2c-4256-aae2-16a786ca6d88",
        "Uid": "2d4a29d1-c61f-43d6-816d-ca1e9be99d89",
        "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-27T13:59:53.687435+00:00",
        "UpdatedBy": "sample string 5"
      },
      "Latitude": "sample string 7",
      "Longitude": "sample string 8",
      "PortalUid": "f15d7b9d-a188-4de0-ae90-be9398908965",
      "PortalGuid": "97fddd03-0fd3-4a70-b9bc-ccb615b3a1d6",
      "CompanyGuid": "3c3d779d-b5fb-49a3-bb46-264bf5f27a8b",
      "Uid": "7752718c-21fb-45cc-9c5a-46f43e82f4b2",
      "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-27T13:59:53.687435+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-27T13:59:53.687435+00:00",
    "ComplianceExpires": "2025-10-27T13:59:53.687435+00:00",
    "CandidateGuid": "319b79be-d284-42f5-81a0-5bf9a600f8d1",
    "DateOfBirth": "2025-10-27T13:59:53.687435+00:00",
    "Nationality": "sample string 29",
    "EmploymentSought": "sample string 30",
    "MinAnnualSalary": 31.1,
    "MaxAnnualSalary": 32.1,
    "MinHourlyPayrate": 33.1,
    "MaxHourlyPayrate": 34.1,
    "Uid": "cc63dc75-8342-4752-a869-ece3144f5738",
    "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-27T13:59:53.687435+00:00",
    "UpdatedBy": "sample string 36"
  },
  "Expires": "2025-10-27T13:59:53.687435+00:00",
  "Status": "sample string 3",
  "Reference": "sample string 4",
  "IssueDate": "2025-10-27T13:59:53.687435+00:00",
  "ApprovedDate": "2025-10-27T13:59:53.687435+00:00",
  "ApprovedBy": "sample string 5",
  "Expired": true,
  "Notes": "sample string 7",
  "ComplianceGuid": "d734f9d0-435b-4c27-ac09-005cf09bce94",
  "Heading": "sample string 9",
  "HeadingDescription": "sample string 10",
  "Uid": "c9d8545d-8172-4e45-bb2a-f4fc725b125d",
  "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-27T13:59:53.687435+00:00",
  "UpdatedBy": "sample string 12"
}

application/xml, text/xml

Sample:

<CandidateComplianceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:59:53.687435+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>c9d8545d-8172-4e45-bb2a-f4fc725b125d</Uid>
  <UpdatedBy>sample string 12</UpdatedBy>
  <ApprovedBy>sample string 5</ApprovedBy>
  <ApprovedDate>2025-10-27T13:59:53.687435+00:00</ApprovedDate>
  <Candidate>
    <DateUpdated>2025-10-27T13:59:53.687435+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>cc63dc75-8342-4752-a869-ece3144f5738</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>319b79be-d284-42f5-81a0-5bf9a600f8d1</CandidateGuid>
    <Company>
      <DateUpdated>2025-10-27T13:59:53.687435+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>7752718c-21fb-45cc-9c5a-46f43e82f4b2</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>3c3d779d-b5fb-49a3-bb46-264bf5f27a8b</CompanyGuid>
      <Country>
        <DateUpdated>2025-10-27T13:59:53.687435+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>2d4a29d1-c61f-43d6-816d-ca1e9be99d89</Uid>
        <UpdatedBy>sample string 5</UpdatedBy>
        <CountryGuid>3485ce72-fe2c-4256-aae2-16a786ca6d88</CountryGuid>
        <Iso3Code>sample string 1</Iso3Code>
        <Name>sample string 2</Name>
        <Portal>
          <DateUpdated>2025-10-27T13:59:53.687435+00:00</DateUpdated>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
          </Links>
          <Uid>f1a66c94-e81a-4474-978e-2caa7328c5c5</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>97fddd03-0fd3-4a70-b9bc-ccb615b3a1d6</PortalGuid>
      <PortalUid>f15d7b9d-a188-4de0-ae90-be9398908965</PortalUid>
      <PostCode>sample string 6</PostCode>
    </Company>
    <ComplianceExpires>2025-10-27T13:59:53.687435+00:00</ComplianceExpires>
    <Country>sample string 10</Country>
    <DateOfBirth>2025-10-27T13:59:53.687435+00:00</DateOfBirth>
    <EarliestStartDate>2025-10-27T13:59:53.687435+00:00</EarliestStartDate>
    <EclipseLastUpdated>2025-10-27T13:59:53.687435+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>
  </Candidate>
  <ComplianceGuid>d734f9d0-435b-4c27-ac09-005cf09bce94</ComplianceGuid>
  <Expired>true</Expired>
  <Expires>2025-10-27T13:59:53.687435+00:00</Expires>
  <Heading>sample string 9</Heading>
  <HeadingDescription>sample string 10</HeadingDescription>
  <IsApproved>true</IsApproved>
  <IssueDate>2025-10-27T13:59:53.687435+00:00</IssueDate>
  <Name>sample string 1</Name>
  <Notes>sample string 7</Notes>
  <Reference>sample string 4</Reference>
  <Status>sample string 3</Status>
</CandidateComplianceViewModel>