Employments
Employee Bank Account

Update employee bank account

Changed on

Upserts the authenticated employee's bank account details.

This endpoint requires and returns country-specific data. The exact fields vary depending on which country the authenticated employee's employment is in. Query the Show form schema endpoint with bank_account_details as the form name to discover the schema for a given country.

Authentication

This endpoint requires the following token type:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage bank accounts (bank_account:write)
put/v1/employee/bank-account

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employee/bank-account
  • Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: bank_account:write, employments, all:write)

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the bank_account_details form schema

Request body

bank_account_detailsobject required

Bank account information. As its properties may vary depending on the country, you must query the Show form schema endpoint passing the country code and bank_account_details as path parameters.

Example request

{
  "bank_account_details": {
    "account_holder_name": "Jane Smith",
    "iban": "GB29NWBK60161331926819"
  }
}

Response

Success

Example response

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}

Changes

  • 9410f5f18a91Revision changes
    • warning

      added the new invited enum value to the // response property for the response status

  • be4636f25834Revision changes
    • info

      removed the offboarding enum value from the // response property for the response status