Get worker's KYC details | Deel

curl -G https://api.letsdeel.com/rest/v2/screenings/kyc/details \
     -H "Authorization: Bearer <token>" \
     -d worker_profile_id=6ad9e983-e68f-473d-9d1d-809ae3d18085 \
     -d contract_id=3rd4qvw \
     -d profile_id=6ad9e984-e68f-473d-9d1d-809ae3d18085

{
  "data": {
    "created_at": "2024-01-15T07:30:00Z",
    "kyc_status": "EXPIRED",
    "updated_at": "2025-01-15T17:30:00Z",
    "approval_date": "2024-01-16T14:20:00Z",
    "rejection_date": null,
    "expiration_date": "2024-01-10T10:30:00Z",
    "submission_date": "2024-01-15T10:30:00Z",
    "identity_document_type": "GOVERNMENT_ID",
    "document_extracted_middle_name": "M",
    "identity_document_number": "DL789012",
    "document_extracted_last_name": "Doe",
    "document_extracted_first_name": "John"
  }
}

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

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

$ curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
>   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

worker_profile_idstringOptionalformat: "uuid"

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

contract_idstringOptional<=100 characters

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_idstringOptionalformat: "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

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

$	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
>	-H 'Authorization: Bearer YOUR-TOKEN-HERE'