BRbridge
External Accounts

Verify an External Account

Changed on

Trigger a verification check for an external account. Verifies that the account_owner_name matches the actual account holder at the receiving bank.

Supported for iban (EUR), gb (GBP), pix (BRL), clabe (MXN), bre_b (COP), and co_bank_transfer (COP, PSE) account types only. Does not require an Idempotency-Key header.

After triggering, poll the external account's account_verification field until completed_at is populated.

post/customers/{customerID}/external_accounts/{externalAccountID}/verify

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID}/verify
  • Auth
    API key in header Api-Key

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

externalAccountIDstring required

A UUID that uniquely identifies a resource

Response

Verification initiated successfully

account_type'iban' | 'gb' | 'pix' | 'clabe' | 'bre_b' | 'co_bank_transfer'

The account type that was verified.

Changes

  • a390532e9fc6Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new bre_b enum value to the response property for the response status

    • warning

      added the new clabe enum value to the response property for the response status

    • warning

      added the new co_bank_transfer enum value to the response property for the response status

    • warning

      added the new pix enum value to the response property for the response status