Request

The POST request includes the hired candidate's details as defined here.

If a set of questions was provided in response to Request hire questionnaire then the details that were added by the recruiter will be included in the partner_questionnaire object as part of the candidate object.

Partner questionnaire object

Field	Type	Description
partner_questionnaire	array of objects	The set of questions that was provided by the partner
partner_questionnaire[].uid	string	Question UID, as provided by the partner
partner_questionnaire[].answers	array	Structure differs by question type: Short answer* - array of strings with one item Date picker* - array of strings with one item, date format is `YYYY-MM-DD` Dropdown* - array of objects with one object Search dropdown* - array of objects with one object
partner_questionnaire[].answers.title	string	Dropdown option title. Available only if the question type is dropdown
partner_questionnaire[].answers.uid	string	Dropdown option UID as provided by the partner. Available only if the question type is dropdown

{
  "recruit_id": "19E.98",
  "person_uid": "05.E4A",
  "first_name": "Bobby",
  "middle_name": "Robert",
  "last_name": "Chauck",
  "email": "bobby.c@example.com",
  "time_created": "2016-08-10T13:30:02Z",
  "phone": "07-4442321",
  "mobile_phone": "052-8644246",
  "id_number": "5454-2233-1",
  "linkedin_url": "https://www.linkedin.com/in/bobby-hauck-06b0735",
  "hired_date": "2016-10-16",
  "start_date": "2016-10-23",
  "partner_questionnaire": [
    {
      "uid": 1,
      "answers": [
        "Billy"
      ]
    },
    {
      "uid": 2,
      "answers": [
        "1985-02-16"
      ]
    },
    {
      "uid": 3,
      "answers": [
        {
          "uid": 1,
          "title": "Product"
        }
      ]
    },
    {
      "uid": 4,
      "answers": [
        {
          "uid": 2071,
          "title": "Stephen Meyer"
        }
      ]
    }    
  ],
  "source": {
    "name": "JobmeHR",
    "type": "Agency",
    "recruit_id": "101E.27"
  },
  "resume": {
    "name": "bobby_cv.docx",
    "url": "https://comeet-xxx.amazonaws.com/65c0a9ff2166g"
  },
  "picture": {
    "url": "https://comeet-xxx.amazonaws.com/e43123cff1231g0"
  },
  "links": [
    {
      "url": "http://www.personalportfolio.com"
    }
  ],
  "files": [
    {
      "name": "Offer letter.pdf",
      "url": "https://comeet-xxx.amazonaws.com/e4376598f1231g0",
      "type": "offer_letter"
    }
  ],
    "offer_fields": [
     {
            "PTO": "25"
     },
     {
            "Car type": "Mini"
      }
   ],
  "opening": {
    "description": "For team A",
    "reason": "new",
    "custom_fields": {
      "Department": "Sales",
      "Type": "Management"
    }
  },
  "position": {
    "comeet_id": "34D.98",
    "name": "Automation QA",
    "public_name": "Automation QA Engineer",
    "description": "<div>QA Automation Engineer - Remote working<br><br>We are looking for a QA Automation Engineer who is excited by the opportunity to build modern, open source software for financial institutions, government regulators, and others taking on the challenges of interoperability and financial inclusion. Here, as QA Automation Engineer, you’ll get the chance to work on something truly unique, that has real, lasting impact in real-time payments, and financial inclusion of the poor.<br><br>Our mission is to improve lives by accelerating universal access to reimagined financial services. It is our belief that technology is the key to driving this access for the most vulnerable and disadvantaged people.<br><br></div>",
    "requirements": "<ul><li>Agile software development experience (Kanban, Scrum)</li><li>Experience with testing and authoring test automation for both REST and SOAP based web services</li><li>Experience working with Selenium using page object modelling</li></ul>",
    "department": "R&D",
    "position_id": "AQA_011",
    "location": "New York",
    "employment": "Full-time",
    "employee_type": "Headcount",
    "seniority": "Senior",
    "hiring_manager": {
      "first_name": "David",
      "last_name": "Black",
      "email": "david.black@example.com"
    },
    "leading_recruiter": {
      "first_name": "Brandon",
      "last_name": "Liao",
      "email": "brandon.liao@company.com"
    },
    "custom_fields": {
      "custom field": "value",
      "custom field 2": "value 2"
    }
  },
  "custom_fields": {
    "custom field": "value",
    "custom field 2": "value 2"
  }
}

Response

Successful response: return HTTP code 200.
Handling errors: return the appropriate HTTP code for the error. The payload must include a clear and actionable description of the problem that will be shown to the user. See the required data structure here.