Added

Background checks

An endpoint to fetch background checks requested with status and results for a contract using the API. And a webhook which gets triggered when a background check is completed. For more info, visit the Help Center .

List background checks by contract

Retrieve the background checks initiated for a contract.

Endpoint: [GET /rest/v2/background-checks/{contract_id}](https://developer.deel.com/reference/getbackgroundchecksbycontractid)

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

Webhook: Get notified when a background check is completed

Triggered when a background check is completed.

Event type: bgcheck.result.available

{
  "data": {
    "meta": {
      "event_type": "bgcheck.result.available",
      "event_type_id": "af7ce5be-d404-4788-aed5-9a5fce1b66c8",
      "organization_id": "987deccd-cef2-4c0f-a068-7cb07971bcfe",
      "organization_name": "Deel",
      "serviceVersion": "2.0.1",
      "tracking_id": "q8tVRj_Je00wJLY2GriqT10nUjBZ"
    },
    "resource": {
      "candidate_email": "[email protected]",
      "completed_at": "2024-09-05T08:32:51. 658Z",
      "contract_id": "3072cm7",
      "created_at": "2024-09-05T08:28:24.394Z",
      "id": "d1f5e39c-fcfd-4f08-b5fa-66ce7112ffef",
      "is_complete": true,
      "name": "Softcheck",
      "package": null,
      "status": "COMPLETE",
      "third party_name": "request softcheck"
    }
  },
  "timestamp": "2024-09-05T08:32:52. 119Z"
}