Right to Work

Right to Work is available in both API versions 1 and 2. However, API version 1 will be deprecated in the future, so new integrations should use API version 2. Requests require the write.right_to_work OAuth scope.

Field descriptions

See the OpenAPI specification for the full schema (including optional fields).

{
  "id": { "type": "string" }, // (Required) Unique identifier for the data
  "document_type": { "type": "string" }, // (Required) Must be "none"
  "credential_type": { "type": "string" }, // (Required) Must be "right_to_work"
  "data": { // { "type": "object" }, (Required)
    "credential": { // { "type": "object" }, (Required)
      "full_name": { "type": "string" }, // (Required)
      "country": { "type": "string" },  // (Required) 2 character ISO Code for the country
      "singapore_work_rights": { "type": "string" }, // (Optional) Required when country is "SG",
      "partner_chain": { "type": ["array", "null"] } // (Optional unless otherwise specified) Array of objects to specifiy partner institutions, e.g. [{ "name": "Partner Organization" }]
    },
  }
}

Leveraging Right to Work fields

Partner chain

The partner_chain field captures intermediate relationships in multi-layered partner hierarchies that aren't represented elsewhere in the integration. It improves the granularity of analytics SEEK Pass can provide to you.Click here for more details.

Sample payload

{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "document_type": "none",
  "credential_type": "right_to_work",
  "data": {
    "credential": {
      "full_name": "John Doe",
      "country": "SG",
      "singapore_work_rights": "resident"
    }
  }
}

Previous: Learning and Development (Microcredential)

Next: Partner chain