Identity Cards

These endpoints let you manage identity cards for employees in the system. It allows you to retrieve, create, update, and delete identity card records.

Get Employee Identity Cards

get

Return the employee identity cards.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Query parameters

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
effectiveDate	<	Less than or equal to Use yyyy-MM-dd format, e.g. effectiveDate<2025-01-31

Example: {"summary":"Search Employee Identity Cards by Effective Date Less Than or Equal To","value":"effectiveDate<2025-01-31"}

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/employees/{employeeId}/employee-identity-cards

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employee-identity-cards?query=effectiveDate%3C2025-01-31" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "61dfe777-f9ea-4a50-b075-734cb62ed20e",
      "identityCardNumber": "1234567890",
      "expiredDate": "1970-01-01",
      "identityCard": {
        "id": "73dabc7c-a7da-11e6-80f5-76304dec7eb7",
        "identityCardType": "OTHER",
        "name": "SIM C"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Employee Identity Cards

post

Create an employee identity card.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Body

application/json

identityCardIdstringRequired

identityCardNumberstring · min: 1 · max: 255Required

Alphanumeric

Pattern: [a-zA-Z0-9]+

expiredDatestring · dateOptional

Responses

201

OK

application/json

400

Bad Request

post

/core/v1/employees/{employeeId}/employee-identity-cards

cURLPython SDK

curl -X POST \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employee-identity-cards" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "identityCardId": "73dabc7c-a7da-11e6-80f5-76304dec7eb7",
  "identityCardNumber": "1234567890",
  "expiredDate": "1970-01-01"
}'

{
  "id": "61dfe777-f9ea-4a50-b075-734cb62ed20e",
  "identityCard": {
    "id": "73dabc7c-a7da-11e6-80f5-76304dec7eb7",
    "name": "SIM C",
    "identityCardType": "OTHER"
  },
  "identityCardNumber": "1234567890",
  "expiredDate": "1970-01-01"
}

Update Employee Identity Cards

put

Update the employee identity card.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

employeeIdentityCardIdstringRequiredExample: b2c3d4e5-f6a7-8901-bcde-f0123456789a

Body

application/json

identityCardIdstringRequired

identityCardNumberstring · min: 1 · max: 255Required

Alphanumeric

Pattern: [a-zA-Z0-9]+

expiredDatestring · dateOptional

Responses

200

OK

application/json

idstringOptional

identityCardNumberstringOptional

expiredDatestringOptional

400

Bad Request

put

/core/v1/employees/{employeeId}/employee-identity-cards/{employeeIdentityCardId}

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employee-identity-cards/b2c3d4e5-f6a7-8901-bcde-f0123456789a" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "identityCardId": "73da9d40-a7da-11e6-80f5-76304dec7eb7",
  "identityCardNumber": "5432154321",
  "expiredDate": "1970-01-01"
}'

{
  "id": "838aa256-d1f7-4c7c-8f47-a2d293d8ef22",
  "identityCard": {
    "id": "73da9d40-a7da-11e6-80f5-76304dec7eb7",
    "name": "PASSPORT",
    "identityCardType": "PASSPORT"
  },
  "identityCardNumber": "5432154321",
  "expiredDate": "1970-01-01"
}

Delete Employee Identity Cards

delete

Delete the employee identity card.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

employeeIdentityCardIdstringRequiredExample: b2c3d4e5-f6a7-8901-bcde-f0123456789a

Responses

200

OK

application/json

anyOptional

400

Bad Request

delete

/core/v1/employees/{employeeId}/employee-identity-cards/{employeeIdentityCardId}

cURLPython SDK

curl -X DELETE \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employee-identity-cards/b2c3d4e5-f6a7-8901-bcde-f0123456789a" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{}