Candidate Confirmation API

The CCW Candidate Confirmation API is designed for customers who manage some or all candidate onboarding activities through third-party applications and want to automate the process of confirming candidates, one at a time, as contingent workers (CWs). The API can process a request to confirm a single candidate, with no other data passed in the request.

The CCW Candidate Lookup API can be used, in conjunction, to find candidates that meet the criteria necessary for confirmation. The Candidate Confirmation API can then confirm each eligible candidate, one by one.

The base URL to access the CCW Candidate Confirmation API is: https://<instance>/api/candidates/<id>/confirm

Refer to the CCW API Overview to learn how to be authenticated by CCW APIs. Requests should include the following elements:

Request Headers

Request headers are required for authentication purposes. See Request Headers section of CCW's API Overview documentation for details.

Example Request

The CCW Candidate Confirm API is supported by the PUT method to confirm one candidate as a CW, by passing only that candidate's unique ID in the API request, with no explicit Request Body required. In the example below, "12345" is the unique ID retrieved from a Candidate Lookup API request:

PUT /api/candidates/12345/confirm
HOST: <CCW FQDN>
Authorization: Bearer <token>
Accept: "application/json"
Correlation-Id: Z098Jth56Nkio343YY1vXt

Example Responses

Below is an example of a successful response. The requested candidate ID is validated and then confirmed. CCW indicates that the confirmation was a success by sending a response with the HTTP 200 response code and the Candidate ID:

{
    "id":"12345"
}

In the following example the confirmation request has failed. The HTTP error code is returned, along with applicable error messages:

{   
 "error_code": "string",
 "error_summary": "string",
 "error_causes": [      
  {   
    "error_sub_code": "string", 
    "error_sub_code_desc": "string",
  }
 ]
}

Error Codes

When a Confirm API request fails, the response will include one of the following error codes: