Added

Background checks

A set of endpoints to request background checks on workers using the API. For more info, visit the Help Center .

List background checks

Retrieve the available background checks. Use country flag to fetch available background checks and packages for a given country.

Endpoint: [GET /rest/v2/background-checks/options](https://developer.deel.com/reference/getbackgroundchecksoptions)

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/background-checks/options \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {}'

Create background check

Request background checks on a worker or an employee contract. You can pass multiple individual checks or a package, available in a given country.

Please note that this EP supports a single contract ID as of now. Support for multiple contract IDs will be added in near future. Please keep an eye on change log for this update.

Endpoint: [POST /rest/v2/background-checks/regular](https://developer.deel.com/reference/createbackgroundcheckforcontracts)

curl --request POST \
     --url https://api.letsdeel.com/rest/v2/background-checks/regular \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {}' \
     --header 'content-type: application/json' \
     --data '{
              "data": {
                  "contract_ids": [
                      "39gz85g"
                  ],
                  "individual_check_ids": [
                      "5699a28e-bf06-4159-b7e3-288e95966321"
                  ],
                  "package_id": "5699a28e-bf06-4159-b7e3-288e95966321"
              }
          }'`

Custom contract upload

Endpoint: [POST /rest/v2/contracts](https://developer.deel.com/reference/createcontract)

Upload a custom contract file as part of the contract creation process. Use a custom contract instead of the standard Deel contract.

Please note that this endpoint requires using a multipart/form-data header and including a custom_contract_file parameter.

If you prefer the standard Deel contract, you can continue using the standard contract creation flow, which requires JSON-formatted data with the application/json header.

curl --location 'https://api.letsdeel.com/rest/v2/contracts' \
--header 'Authorization: Bearer {}' \
--form 'country_code="NO"' \
--form 'scope_of_work="scope_of_work"' \
--form 'client[legal_entity][id]="b27489e0-9f13-4814-ad53-67f5fd258ac9"' \
--form 'client[team][id]="6243f9f8-fd23-49d8-8816-56378acc6b5c"' \
--form 'job_title[name]="Algorithm Engineer"' \
--form 'seniority[id]="6"' \
--form 'notice_period="15"' \
--form 'who_reports="both"' \
--form 'meta[documents_required]="false"' \
--form 'meta[is_main_income]="false"' \
--form 'title="Ms. Homer Stokes payg_tasks"' \
--form 'worker[expected_email]="[email protected]"' \
--form 'worker[first_name]="Josiah"' \
--form 'worker[last_name]="Veum Custom"' \
--form 'type="payg_tasks"' \
--form 'start_date="2024-08-19"' \
--form 'compensation_details[amount]="20000"' \
--form 'compensation_details[currency_code]="NOK"' \
--form 'compensation_details[frequency]="monthly"' \
--form 'compensation_details[cycle_end]="1"' \
--form 'compensation_details[cycle_end_type]="DAY_OF_MONTH"' \
--form 'compensation_details[payment_due_type]="REGULAR"' \
--form 'compensation_details[payment_due_days]="0"' \
--form 'compensation_details[pay_before_weekends]="true"' \
--form 'compensation_details[first_payment_date]="2024-10-01"' \
--form 'compensation_details[first_payment]="2000"' \
--form 'compensation_details[notice_period]="15"' \
--form 'compensation_details[scale]="weekly"' \
--form 'custom_contract_file=@"/Users/Downloads/contract.pdf"'