Onboarding flow

retrieve the info of a worker

Changed on
get/public/onboarding/v1/get-worker-details

Request

Query parameters

workerIdstring uuid required

Response

Successfully retrieved a worker

firstNamestring required
emailAddressstring email required
mobilePhoneNumberstring required

Example response

{
  "address": {
    "houseNumber": 102,
    "houseNumberAddition": "B",
    "zipCode": "5652AA",
    "countryCode": "US"
  }
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to string for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from string to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      response schema application/json enum value removed COUNTRY_ADDRESS_NOT_SUPPORTED

    • info

      response schema application/json enum value removed EMAIL_ADDRESS_IN_USE

    • info

      response schema application/json enum value removed INVALID_BSN

    • info

      response schema application/json enum value removed INVALID_COUNTRY

    • info

      response schema application/json enum value removed INVALID_DOCUMENT

    • info

      response schema application/json enum value removed INVALID_EMAIL

    • info

      response schema application/json enum value removed INVALID_HOUSE_NUMBER_ADDITION

    • info

      response schema application/json enum value removed INVALID_IBAN

    • info

      response schema application/json enum value removed INVALID_NATIONALITY

    • info

      response schema application/json enum value removed INVALID_NON_EER_WORKER_AND_NATIONALITY_COMBINATION

    • info

      response schema application/json enum value removed INVALID_PHONE_NUMBER

    • info

      response schema application/json enum value removed INVALID_ZIP_CODE

    • info

      response schema application/json enum value removed LEGAL_WORK_CATEGORY_NOT_SUPPORTED

    • info

      response schema application/json enum value removed WORKER_ALREADY_HAS_AN_ACCOUNT