Dynamic Requirements | Deel

curl -X POST https://api.letsdeel.com/rest/v2/payouts/employees/methods/bank_transfers/requirements \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {
    "current_state": {
      "payment_type": "bank_transfer",
      "currency_code": "EUR",
      "bank_country_code": "LT"
    }
  }
}'

{
  "data": {
    "steps": [
      {
        "name": "CUSTOMIZE_ACCOUNT",
        "header": "Custom account name",
        "categories": [
          {
            "name": "CUSTOMIZATION",
            "alert": {
              "type": "INFO",
              "title": "Account Name",
              "message": "Add custom account name"
            },
            "fields": [
              {
                "id": 1678,
                "key": "custom_name",
                "name": "Account Custom Name",
                "type": "text",
                "category": "CUSTOMIZATION",
                "disabled": false,
                "required": false,
                "sensitive": false,
                "max_length": "30",
                "min_length": "0"
              }
            ],
            "header": "Account name",
            "priority": 1
          }
        ],
        "right_side_placeholder": "Customize account"
      },
      {
        "name": "BANK_DETAILS",
        "header": "Bank account details",
        "categories": [
          {
            "name": "ROUTING",
            "fields": [
              {
                "id": 1676,
                "key": "payment_type",
                "name": "Payment type",
                "type": "select",
                "category": "ROUTING",
                "disabled": false,
                "required": false,
                "sensitive": false
              },
              {
                "id": 1677,
                "key": "currency_code",
                "name": "Currency",
                "type": "select",
                "category": "ROUTING",
                "disabled": false,
                "required": true,
                "sensitive": false
              },
              {
                "id": 1679,
                "key": "bank_country_code",
                "name": "Bank Country Code",
                "type": "select",
                "category": "ROUTING",
                "disabled": false,
                "required": true,
                "sensitive": false
              }
            ],
            "header": "Payment details",
            "priority": 2
          },
          {
            "name": "BANK_DETAILS",
            "fields": [
              {
                "id": 109,
                "key": "swift_bic",
                "name": "SWIFT BIC Code",
                "type": "text",
                "category": "BANK_DETAILS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "11",
                "min_length": "8"
              },
              {
                "id": 321,
                "key": "iban",
                "name": "IBAN",
                "type": "text",
                "category": "BANK_DETAILS",
                "disabled": false,
                "required": true,
                "sensitive": false
              }
            ],
            "header": "Account details",
            "priority": 1
          }
        ],
        "right_side_placeholder": "Add bank account details"
      },
      {
        "name": "RECIPIENT_DETAILS",
        "header": "Personal information",
        "categories": [
          {
            "name": "PERSONAL",
            "fields": [
              {
                "id": 34,
                "key": "full_name",
                "name": "Full Name",
                "type": "text",
                "category": "PERSONAL",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "140",
                "min_length": "1"
              }
            ],
            "header": "Recipient details",
            "priority": 2
          },
          {
            "name": "ADDRESS",
            "fields": [
              {
                "id": 68,
                "key": "address_line1",
                "name": "Address Line 1",
                "type": "text",
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "70",
                "min_length": "1"
              },
              {
                "id": 69,
                "key": "address_line2",
                "name": "Address Line 2",
                "type": "text",
                "category": "ADDRESS",
                "disabled": false,
                "required": false,
                "sensitive": false,
                "max_length": "70",
                "min_length": "0"
              },
              {
                "id": 70,
                "key": "city",
                "name": "City",
                "type": "text",
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "35",
                "min_length": "1"
              },
              {
                "id": 107,
                "key": "country_code",
                "name": "Country Code",
                "type": "select",
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false
              },
              {
                "id": 211,
                "key": "province_state",
                "name": "State",
                "type": "text",
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "35",
                "min_length": "1"
              },
              {
                "id": 287,
                "key": "postal",
                "name": "Postal Code",
                "type": "text",
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false
              }
            ],
            "header": "Address",
            "priority": 1
          }
        ],
        "right_side_placeholder": "Add recipient details"
      }
    ],
    "is_final": true,
    "requirements_id": 1250
  }
}

Dynamic Requirements Token scopes: worker:read, worker:write

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.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

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

Request

This endpoint expects an object.

dataobjectOptional

Request data

Response

Dynamic Requirements

dataobject

Response data

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'