Deel Eor Worker Banks API

openapi: 3.2.0
info:
  title: Endpoints Eor Worker Banks API
  version: 1.0.0
servers:
- url: https://api.letsdeel.com/rest
  description: Production
- url: https://api-staging.letsdeel.com/rest
  description: Demo
- url: https://api.letsdeel.com/scim/v2
  description: Production
- url: https://api-staging.letsdeel.com/scim/v2
  description: Demo
tags:
- name: eorWorkerBanks
paths:
  /eor/workers/banks-guide/country/{country}/currency/{currency}:
    get:
      operationId: eorWorkerBanks_getEORWorkerBankGuideByCountryAndCurrency
      summary: Retrieve bank account guide
      description: 'Returns the bank account form guide for the specified `country` and `currency` combination, providing the field structure required to add a new bank account for an EOR employee.


        **Token scopes**: `worker:read`'
      tags:
      - eorWorkerBanks
      parameters:
      - name: country
        in: path
        description: Country
        required: true
        schema:
          type: string
      - name: currency
        in: path
        description: Currency
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200'
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError'
        '401':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '403':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
      security:
      - deelToken: []
  /eor/workers/banks/guide:
    get:
      operationId: eorWorkerBanks_getEORWorkerBankGuide
      summary: Retrieve bank account guide
      description: 'Returns the bank account form guide for an EOR employee, providing the field structure required to add a new bank account.


        **Token scopes**: `worker:read`'
      tags:
      - eorWorkerBanks
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eor-worker-banks_getEORWorkerBankGuide_Response_200'
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '403':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
      security:
      - deelToken: []
components:
  schemas:
    eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems'
      required:
      - data
      title: eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide:
      type: object
      properties:
        label:
          type: string
          description: Label for this field.
        order:
          type: integer
          description: Order of the field in the form.
        helper_text:
          type:
          - string
          - 'null'
          description: Helper text to guide the user.
      description: UI guidance information for rendering this field in forms.
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide
    eor-worker-banks_getEORWorkerBankGuide_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems'
      required:
      - data
      title: eor-worker-banks_getEORWorkerBankGuide_Response_200
    EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        key:
          type: string
          description: The key of the field.
        type:
          type: string
          description: Type of the field
        label:
          type: string
          description: Label for this field.
        required:
          type: boolean
          description: Whether the field is required or not.
        validations:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems'
        values_allowed:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems'
      required:
      - key
      - required
      title: EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems
    EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType'
        value:
          $ref: '#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue'
      title: EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue:
      oneOf:
      - type: string
      - type: number
        format: double
      description: The value to use for the validation rule (e.g., minimum length, regex pattern).
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue
    EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue:
      oneOf:
      - type: string
      - type: number
        format: double
      title: EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue
    EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems:
      type: object
      properties:
        label:
          type: string
          description: The name of the allowed value.
        value:
          type: string
          description: The value of the allowed value.
      title: EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems
    RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems'
      title: RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType'
          description: The type of validation rule to apply.
        value:
          $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue'
          description: The value to use for the validation rule (e.g., minimum length, regex pattern).
        error_message:
          type: string
          description: Error message to be displayed if validation fails.
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems
    EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType:
      type: string
      enum:
      - MIN_LENGTH
      - MAX_LENGTH
      - REGEX
      title: EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType
    ApiErrorRequest:
      type: object
      properties:
        method:
          type: string
          description: The HTTP method of the failed request
        url:
          type: string
          description: The relative URL of the failed request
        status:
          type: number
          format: double
          description: The status code of the response
        api_req_id:
          type: string
          description: The request ID of the failed request
        docs:
          type: string
          description: A link to the official documentation for the requested endpoint resource
        source:
          type: string
          description: The source handler which produced the returned error
        code:
          type: number
          format: double
          description: The code of the source handler which produced the returned error
      title: ApiErrorRequest
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        key:
          type: string
          description: The key of the field.
        type:
          type: string
          description: Type of the field
        ui_guide:
          $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide'
          description: UI guidance information for rendering this field in forms.
        is_required:
          type:
          - boolean
          - 'null'
          description: Whether the field is required or not.
        validations:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems'
          description: Array of validation rules that apply to this field.
        values_allowed:
          type: array
          items:
            $ref: '#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems'
          description: Array of allowed values for this field (used for dropdowns, select lists, etc.).
      required:
      - key
      - ui_guide
      - is_required
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems
    ApiErrorContainer:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ApiErrorRequest'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiError'
      title: ApiErrorContainer
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems:
      type: object
      properties:
        label:
          type: string
          description: The name of the allowed value.
        value:
          type: string
          description: The value of the allowed value.
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType:
      type: string
      enum:
      - MIN_LENGTH
      - MAX_LENGTH
      - REGEX
      description: The type of validation rule to apply.
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: A description of the returned error
        path:
          type: string
          description: The JSON path where input validation failed
      title: ApiError
    EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        field:
          type: string
          description: Name of the field causing the error (for validation issues)
        message:
          type: string
          description: Human-readable explanation of the error
      title: EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems
  securitySchemes:
    deelToken:
      type: http
      scheme: bearer
      description: "## Authentication\nThe 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.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)"
    oauth2:
      type: http
      scheme: bearer
      description: Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
x-provenance:
  method: harvested
  publisher: Deel
  source: https://developer.deel.com/openapi/endpoints-5.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)