New List Contract Amendments API, Worker KYC Details endpoints and enhancements in existing ones

New List Contract Amendments API

Retrieve amendments of a contract.

Path Parameters:

• contract_id (string, required) - Unique identifier of the contract (UUID format)

Query Parameters:

• statuses (array of strings, optional) - Filter by work statement status. Available values: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
• sign_statuses (array of strings, optional) - Filter by work statement sign status. Available values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED
• limit (integer, optional) - Maximum number of work statements to return (default: 20, minimum: 1, maximum: 100)
• cursor (string, optional) - Cursor for pagination

Sample Request:

curl --request GET \
  "https://api.letsdeel.com/rest/v2/contracts/123e4567-e89b-12d3-a456-426614174000/amendments?statuses=PENDING,ACTIVE&limit=10" \
  --header "accept: application/json" \
  --header "authorization: Bearer {API_TOKEN}" \
  --header "content-type: application/json"

Success Response (200):

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "ACTIVE",
      "sign_status": "APPROVED",
      "created_at": "2024-01-15T10:00:00.000Z",
      "updated_at": "2024-01-20T14:30:00.000Z",
      "contract_name": "Software Development Contract",
      "contract_type": "ongoing_time_based",
      "effective_date": "2024-02-01"
    }
  ],
  "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0wMS0xNVQxMDowMDowMC4wMDBaIiwicHVibGljX2lkIjoiZGVmNDU2In0",
  "has_more": true,
  "total_count": 150
}

Success Response:

• data (array) - List of work statements (amendments)
  • data[].id (string) - Unique identifier for the work statement (UUID format)
  • data[].status (string) - Current status of the work statement. Available values: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
  • data[].sign_status (string) - Current sign status of the work statement. Available values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED
  • data[].created_at (string) - Timestamp when the work statement was created (ISO 8601 format)
  • data[].updated_at (string) - Timestamp when the work statement was last updated (ISO 8601 format)
  • data[].contract_name (string, nullable) - Name of the associated contract
  • data[].contract_type (string, nullable) - Type of the associated IC contract. Available values: milestones, time_based, ongoing_time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks
  • data[].effective_date (string, nullable) - Effective date when the work statement becomes active (date format)
• cursor (string, nullable) - Cursor for the next page of results
• has_more (boolean) - Indicates if there are more work statements available
• total_count (integer) - Total number of work statements matching the filters

API Reference: List Contract Amendments API

New Worker's KYC Details Endpoint

Adds a new GET API endpoint to alloww 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

Endpoint: GET /rest/v2/screenings/kyc/details

Token scopes: screenings:read

Request Example:

curl --location 'https://api.letsdeel.com/rest/v2/screenings/kyc/details?worker_profile_id={WORKER_PROFILE_ID}
--header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN} --header 'content-type: application/json'

API Reference: Get worker's KYC details

Enhancement: Request job scope validation

Added client_name property to the request payload.

API Reference: Request job scope validation

Enhancement: Sign worker contract

Added created_at and updated_at properties to the response.

API Reference: Sign worker contract