# Linked Account Update

Notification of the status update for a linked Account.

Endpoint: POST linkedAccountWatch
Version: v1
Security: apiKey, authToken

## 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)

  - `payload.id` (string, required)
    The unique identifier of the linked account
    Example: 652d25b73541d8084a88a38d

  - `payload.accountIdentification` (any, required)
    The bank details that uniquely identify the account on the banking systems.

  - `payload.accountIdentification.accountNumber` (string, required)
    Account number, required for wire transfer over Faster Payments.

  - `payload.accountIdentification.sortCode` (string, required)
    Sort code, required for wire transfer over Faster Payments.

  - `payload.accountIdentification.secondaryReference` (string)
    Secondary reference data if applicable.

  - `payload.accountIdentification.iban` (string, required)
    International Bank Account Number, required for wire transfer over SEPA.

  - `payload.accountIdentification.bankIdentifierCode` (string)
    BIC, for wire transfer over SEPA.

  - `payload.currency` (string, required)
    The primary currency associated with the account
    Enum: "GBP", "EUR"

  - `payload.institution` (object, required)

  - `payload.institution.displayName` (string)
    The name to be used when displaying the institution to users on user interfaces

  - `payload.institution.countries` (array, required)
    The institution's supported countries

  - `payload.institution.images` (object)
    The images that should be used when displaying the institution

  - `payload.institution.images.icon` (string)

  - `payload.institution.images.logo` (string)

  - `payload.institution.info` (object)

  - `payload.institution.info.loginUrl` (string)

  - `payload.institution.info.helplinePhoneNumber` (string)

  - `payload.consent` (object, required)

  - `payload.consent.expiresAt` (string, required)

  - `payload.consent.expiresIn` (integer, required)

  - `payload.consent.status` (string, required)
    Enum: "ACTIVE", "EXPIRED", "REVOKED"

  - `payload.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"

  - `payload.friendlyName` (string)
    A user-friendly name for the linked account

  - `payload.buyerId` (string, required)
    The id of the buyer that this linked account belongs to.

  - `payload.userId` (string, required)
    The id of the user who initially created this linked account.

  - `payload.status` (string)
    Enum: "ERROR_DUPLICATED_ACCOUNT"