Get worker's KYC details

This endpoint allows organizations managing workers on Deel to retrieve detailed KYC verification data using the worker’s profile ID. It provides comprehensive information including verification status, document type, submission, approval, rejection, and expiry dates, supporting compliance monitoring and onboarding workflows Token scopes: screenings:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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<=7 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

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

1	{
2	"data": {
3	"created_at": "2024-01-15T07:30:00Z",
4	"kyc_status": "EXPIRED",
5	"updated_at": "2025-01-15T17:30:00Z",
6	"approval_date": "2024-01-16T14:20:00Z",
7	"rejection_date": null,
8	"expiration_date": "2024-01-10T10:30:00Z",
9	"submission_date": "2024-01-15T10:30:00Z",
10	"identity_document_type": "GOVERNMENT_ID",
11	"document_extracted_middle_name": "M",
12	"identity_document_number": "DL789012",
13	"document_extracted_last_name": "Doe",
14	"document_extracted_first_name": "John"
15	}
16	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication