Screenings

Get worker's KYC details

Retrieves KYC verification details for a worker identified by worker_profile_id or profile_id; these two parameters are mutually exclusive. contract_id is required when multiple profiles are associated with the worker.

Token scopes: screenings:read

get/screenings/kyc/details

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/screenings/kyc/details
  • Auth: HTTP bearer

Query parameters

worker_profile_idstring uuid

Worker's HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id

contract_idstring

Worker's contract ID. This parameter is required in case there are multiple profiles associated to the target worker. For example, when worker used to work for the former company he had another profile ID. So we need contract ID to properly resolve profile's KYC details. In case this parameter is not provided and multiple associated profiles are found, exception with 409 status code will be thrown

profile_idstring uuid

Worker's profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_id

Response

KYC details retrieved successfully

Changes

No recorded changes to this operation across all 1 revision of this API.