Skip to navigation

Get payroll activation readiness for a legal entity

Beta

Returns whether a legal entity has reached payroll activation readiness, giving clients and partners a self-serve signal they can check over the public API instead of asking Deel support. Call it before starting a step that requires payroll to already be active for the legal entity, and gate that step on the result. A legal entity whose activation is still in progress, or that has none yet, is reported as not ready.

Token scopes: global-payroll:read

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-12.

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

OR
AuthorizationBearer

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

Query parameters

legal_entity_idstringRequiredformat: "uuid"
The unique identifier of the legal entity whose payroll readiness should be returned.

Response

OK
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error