# Linked Account Update

Notification of the status update for a linked Account.

Endpoint: POST linkedAccountWatch
Version: v1
Security: 

## Header parameters:

  - `call-ref` (string)
    A call reference generated by the caller and unique to the caller
to provide correlation between the caller and system with a maximum length
of 255

  - `published-timestamp` (integer, required)
    The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

  - `signature` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

  - `signature-v2` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

## Request fields (application/json):

  - `type` (string, required)
    Enum: "linkedAccountWatch"

  - `payload` (object, required) — one of:
    - Linked Account Status:
      - `id` (string, required)
        The unique identifier of the linked account
        Example: "652d25b73541d8084a88a38d"
      - `accountIdentification` (any, required) — one of:
        The bank details that uniquely identify the account on the banking systems.
        - FasterPaymentsBankDetails:
          - `accountNumber` (string, required)
            Account number, required for wire transfer over Faster Payments.
          - `sortCode` (string, required)
            Sort code, required for wire transfer over Faster Payments.
          - `secondaryReference` (string)
            Secondary reference data if applicable.
        - SepaBankDetails:
          - `iban` (string, required)
            International Bank Account Number, required for wire transfer over SEPA.
          - `bankIdentifierCode` (string)
            BIC, for wire transfer over SEPA.
      - `currency` (string, required)
        The primary currency associated with the account
        Enum: "GBP", "EUR"
      - `institution` (object, required)
      - `institution.displayName` (string)
        The name to be used when displaying the institution to users on user interfaces
      - `institution.countries` (array, required)
        The institution's supported countries
        Enum: "GB", "AT", "BE", "BG", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GI", "GR", "HU", "IS", "IE", "IT", "LV", "LI", "LT", "LU", "MT", "NL", "NO", "PL", "PT", "RO", "SK", "SI", "ES", "SE"
      - `institution.images` (object)
        The images that should be used when displaying the institution
      - `institution.images.icon` (string)
      - `institution.images.logo` (string)
      - `institution.info` (object)
      - `institution.info.loginUrl` (string)
      - `institution.info.helplinePhoneNumber` (string)
      - `consent` (object, required)
      - `consent.expiresAt` (string, required)
      - `consent.expiresIn` (integer, required)
      - `consent.status` (string, required)
        Enum: "ACTIVE", "EXPIRED", "REVOKED"
      - `status` (string, required)
        The status of the linked account. The status can be one of the following:

- PENDING_CHALLENGE: The Linked Account is pending challenge
- PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps
- PENDING_FUNDING: Awaiting a wire transfer as part of the verification process when adding an account without Open Banking
- REJECTED: The Linked Account did not pass one or more verification steps and is not eligible for use
- LINKED: The linked account is linked and ready for use
- UNLINKED: The linked account is not linked and cannot be used
        Enum: "LINKED", "UNLINKED", "PENDING_CHALLENGE", "PENDING_FUNDING", "PENDING_VERIFICATION", "REJECTED"
      - `friendlyName` (string)
        A user-friendly name for the linked account
      - `buyerId` (string, required)
        The id of the buyer that this linked account belongs to.
      - `userId` (string, required)
        The id of the user who initially created this linked account.
    - StatusErrorDuplicatedAccount:
      - `accountIdentification` (any, required) — one of:
        The bank details that uniquely identify the account on the banking systems.
        - FasterPaymentsBankDetails:
          - `accountNumber` (string, required)
            Account number, required for wire transfer over Faster Payments.
          - `sortCode` (string, required)
            Sort code, required for wire transfer over Faster Payments.
          - `secondaryReference` (string)
            Secondary reference data if applicable.
        - SepaBankDetails:
          - `iban` (string, required)
            International Bank Account Number, required for wire transfer over SEPA.
          - `bankIdentifierCode` (string)
            BIC, for wire transfer over SEPA.
      - `currency` (string, required)
        The primary currency associated with the account
        Enum: same as `currency` in "Linked Account Status" (2 values)
      - `institution` (object, required)
      - `institution.displayName` (string)
        The name to be used when displaying the institution to users on user interfaces
      - `institution.countries` (array, required)
        The institution's supported countries
        Enum: same as `institution.countries` in "Linked Account Status" (32 values)
      - `institution.images` (object)
        The images that should be used when displaying the institution
      - `institution.images.icon` (string)
      - `institution.images.logo` (string)
      - `institution.info` (object)
      - `institution.info.loginUrl` (string)
      - `institution.info.helplinePhoneNumber` (string)
      - `status` (string, required)
        Enum: "ERROR_DUPLICATED_ACCOUNT"
    - StatusRejected:
      - `status` (string, required)
        Enum: "REJECTED"
      - `consent` (object, required)
      - `consent.status` (string, required)
        Enum: same as `status` in "StatusRejected" (1 values)
    - StatusRejectedMultipleLinkedAccounts:
      - `status` (string, required)
        Enum: "CANNOT_LINK_MULTIPLE_ACCOUNTS"
      - `consent` (object, required)
      - `consent.status` (string, required)
        Enum: same as `status` in "StatusRejected" (1 values)


## Response 200 fields