Candidate Registry

Registry Import

Optional

Provider must expose an endpoint to fetch existing candidate registry during customer onboarding.

Endpoint

GET /candidates/registry

Purpose

When a company starts using Seamlr, import their existing workforce data.

Response Schema

{
  "candidates": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employeeNumber": "EMP-123",
      "firstName": "Anna",
      "lastName": "Svensson",
      "personalNumber": "YYYYMMDDXXXX",
      "address": "Storgatan 1",
      "postCode": "12345",
      "city": "Stockholm",
      "countryCode": "se",
      "phone": "+46701234567",
      "email": "anna@example.com",
      "emergencyContact": {
        "name": "Erik Svensson",
        "phone": "+46709876543",
        "relationship": "Spouse"
      },
      "bankDetails": {
        "clearingNumber": "1234",
        "accountNumber": "1234567890"
      },
      "workHistory": [
        {
          "shiftId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
          "date": "2024-01-15",
          "roleId": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
          "roleName": "Server",
          "outletId": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
          "outletName": "Downtown Location"
        }
      ]
    }
  ]
}

Field	Type	Description
`id`	string (UUID)	Candidate identifier
`employeeNumber`	string	Internal employee number
`personalNumber`	string	Swedish personal number (YYYYMMDDXXXX)
`emergencyContact`	object	Emergency contact information (ICE)
`bankDetails`	object	Bank account for payments
`workHistory`	array	Previous shifts worked

New Candidate Registration

Required

When Seamlr hires new staff for a company, the provider receives full candidate details.

Endpoint

POST /candidates

Extended Request Schema

{
  "personalNumber": "YYYYMMDDXXXX",
  "firstName": "John",
  "lastName": "Doe",
  "address": "Kungsgatan 10",
  "postCode": "11122",
  "city": "Stockholm",
  "countryCode": "se",
  "phone": "+46701234567",
  "email": "john@example.com",
  "emergencyContact": {
    "name": "Jane Doe",
    "phone": "+46709876543",
    "relationship": "Spouse"
  },
  "bankDetails": {
    "clearingNumber": "1234",
    "accountNumber": "1234567890"
  },
  "documents": {
    "citizenship": "SE",
    "workPermitRequired": false,
    "workPermitExpiry": null,
    "passportVerified": true
  }
}

Documents Fields

Field	Type	Description
`documents.citizenship`	string	ISO country code
`documents.workPermitRequired`	boolean	Whether work permit is needed
`documents.workPermitExpiry`	string (ISO 8601)	Work permit expiration date
`documents.passportVerified`	boolean	Whether passport has been verified