Career History

Field descriptions

Copy
{
  "id": { "type": "string" }, // (Required) Unique identifier for the data
  "document_type": { "type": "string" }, // (Required) Must be "none"
  "credential_type": { "type": "string" }, // (Required) Must be "career_history"
  "data": { // { "type": "object" }, (Required)
    "credential": { // { "type": "object" }, (Required)
      "full_name": { "type": "string" }, // (Required)
      "employment" : [
        {
          "organisation": { "type": "string" }, // (Required) Name of the company or employer
          "role_classification": { "type": "string" }, // Category or type of the position held
          "role_title": { "type": "string" }, // Official job title for the employment period
          "start_date": { "type": "string", "format": "date" }, // (Required) Date employment began, Date format: "YYYY-MM"
          "end_date": { "anyOf": [ { "type": "string", "format": "date"}, { "type": "null" }] }, // Date employment ended, Date format: "YYYY-MM"
          "last_processed_month": { "type": "string", "format": "date" }, // (Required) Most recent month for which employment data was updated, Date format: "YYYY-MM"
        }
      ]
    },
  }
}

Leveraging Career History fields

Below are detailed explanations for each field in the Career History credential. These descriptions are intended to help partners understand the purpose and correct usage of each field:

Credential object fields

• full_name: The full legal name of the individual whose career history is being described. This should match the name as it appears on official documents.

• employment: An array of employment records, each representing a distinct period of employment.

Employment object fields

• organisation: The name of the company or employer where the individual worked. This should be the official or commonly recognized name of the organization.

• role_classification: The general category or classification of the role held. This should be a broad, standardized label that describes the type of work performed, such as "Software Engineer", "Accountant", "Project Manager", or "Sales Representative".

• role_title: The specific job title held by the individual during this employment period. This should be the official title used by the employer, such as "Associate Software Engineer", "Senior Manager", or "Sales Executive". It reflects the exact position name as recorded in employment contracts, payslips, or other official documents.

Note: At least one of role_classification or role_title must be provided for each employment record. Providing both is recommended for clarity, but if only one is available, ensure that field is populated.

• start_date: The month and year when the employment began, formatted as "YYYY-MM". This field is required.

• end_date: The month and year when the employment ended, formatted as "YYYY-MM". If the individual is still employed, this field may be omitted.

• last_processed_month: The most recent month for which employment data was updated, formatted as "YYYY-MM". This is required and should reflect the latest month for which the employment status or details were confirmed.

Note: All date fields must use the format "YYYY-MM" (e.g., "2023-01").

Partner chain

Sample payload

Copy
{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "document_type": "none",
  "credential_type": "career_history",
  "data": {
    "credential": {
      "full_name": "John Doe",
      "employment": [
        {
          "organisation": "Company A",
          "role_classification": "Software Engineer",
          "role_title": "Associate Software Engineer",
          "start_date": "2020-01",
          "end_date": "2022-12",
          "last_processed_month": "2023-01"
        },
        {
          "organisation": "Company B",
          "role_classification": "Software Engineer",
          "role_title": "Senior Software Engineer",
          "start_date": "2023-02",
          "last_processed_month": "2024-05"
        }
      ]
    }
  }
}