GET
/
lucca-api
/
employee-personal-records
/
{id}
Retrieve an employee-personal-record
curl --request GET \
  --url https://{host}/lucca-api/employee-personal-records/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "id": "897",
  "type": "employee-personal-record",
  "url": "https://example.ilucca.net/lucca-api/employee-personal-records/897",
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "title": "mister",
  "legalGender": "male",
  "birthDate": "1989-12-21",
  "insuranceNumber": {
    "format": "frenchSSN",
    "value": "1760774865895 37"
  },
  "nationalitiesCountryCodes": [
    "FRA"
  ],
  "bankAccount": {
    "format": "iban",
    "iban": "FR8817569000503595615775H03",
    "bic": "PSSTFRPPXXX"
  },
  "phoneNumber": "+33456789634",
  "email": "jdoe13@gmail.com",
  "links": null,
  "embedded": {
    "employee": {
      "416": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416",
        "remoteId": "00002345",
        "portrait": {
          "id": "66512232",
          "type": "portrait",
          "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
        },
        "givenName": "Edward",
        "familyName": "Atkinson",
        "employeeNumber": "E000124",
        "status": "active",
        "email": "eatkinson@acme.corp",
        "birthDay": {
          "day": 22,
          "month": 12
        },
        "phoneNumber": "+33145784512",
        "applicableEmployment": {
          "id": "154",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/154"
        },
        "applicableJobPosition": {
          "id": "74",
          "type": "job-position",
          "url": "https://example.ilucca.net/lucca-api/job-positions/74"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "employments": {
            "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
          },
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
          },
          "personalRecord": {
            "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
          }
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

​
Api-Version
enum<string>
required

Set the API version.

Available options:
TitleConst
2024-11-01
Examples:

"2024-11-01"

​
If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Examples:

"W/q5sd4w2x1c1gfdg"

​
If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Examples:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Path Parameters

​
id
string
required

Identifier of the employee-personal-record to retrieve.

Query Parameters

​
include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Response

OK

The employee-personal-record resource represents the confidential attributes of an employee, i.e. sensitive personal information about them which gives details of their background, identity proofs, and qualifications. Embedded resources on a employee-personal-record(s) response. An employee-personal-record resource.

​
id
string
required
Minimum length: 1
​
type
string
required
Allowed value: "employee-personal-record"
​
url
string<uri>
required
​
employee
object
required

Reference to an employee resource. Only one employee-personal-record per employee.

Examples:
{
  "id": "416",
  "type": "employee",
  "url": "https://example.ilucca.net/lucca-api/employees/416"
}
​
title
enum<string>
  • unknown: Not indicated. Equivalent to a technical null.
  • mister: Either married or unmarried man. French: 'Monsieur'.
  • miss: Unmarried woman. French: 'Mademoiselle'.
Available options:
unknown,
mister,
miss
​
legalGender
enum<string>
default:unknown

"Unknown" is equivalent to "unspecified" or "null".

"Diverse" may be legally acknowledged in some countries (e.g. Germany).

Available options:
unknown,
male,
female,
diverse
Examples:

"unknown"

​
birthDate
string<date> | null

YYYY-MM-DD formatted date of birth.

​
insuranceNumber
object | null

Validation depends on selected format. Value for "other" format is not validated.

​
nationalitiesCountryCodes
enum<string>[]

Array of ISO 3166-1 alpha-3 country codes.

Maximum length: 1
​
bankAccount
object | null

Represents a bank account in any format, including IBAN, SWIFT, and region-specific routing details.

Examples:
{
  "format": "iban",
  "bankName": "BNP Paribas",
  "accountIdentifier": "FR7630006000011234567890189",
  "bankIdentifier": null
}
{
  "format": "other",
  "bankName": "JPMorgan Chase Bank",
  "accountNumber": "123456789",
  "routingNumber": "021000021"
}
​
phoneNumber
string<phone>

Phone number.

Examples:

"+3356565656"

​
email
string<email> | null

Personal email address of the employee.

​
links
null
​
embedded
object | null