External Accounts

Create a new External Account

Changed on

Note: If adding US external accounts, we recommend reading through the US Beneficiary Address Validation doc (link) to avoid issues related to incorrect addresses.

post/customers/{customerID}/external_accounts

Request

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

Headers

Idempotency-Keystring required

Request body

OR
OR
OR
OR
OR
OR
OR

Response

External Account object created

OR
OR
OR
OR
OR
OR

Changes

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • breaking

      removed from the request body oneOf list

    • breaking

      request property ////// was restricted to a list of enum values

    • breaking

      request property ///// was restricted to a list of enum values

    • breaking

      request property ///// was restricted to a list of enum values

    • breaking

      request property ///// was restricted to a list of enum values

    • breaking

      request property ///// was restricted to a list of enum values

    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the ///// request property's minLength was increased from 0 to 1

    • breaking

      the ///// request property type changed from no type to string

    • breaking

      the ///// request property type changed from no type to string

    • breaking

      the // request property type changed from no type to object

    • breaking

      the ///// request property type changed from no type to string

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      the ///// request property's maxLength was set to 256

    • warning

      the ///// request property's maxLength was set to 256

    • warning

      the ///// request property's maxLength was set to 256

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property ///

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property ///

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property ///

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new deactivated_due_to_bounceback enum value to the request property //////

    • info

      added the new deactivated_due_to_bounceback enum value to the request property /////

    • info

      added the new deactivated_due_to_bounceback enum value to the request property /////

    • info

      added the new deactivated_due_to_bounceback enum value to the request property /////

    • info

      added the new deactivated_due_to_bounceback enum value to the request property /////

    • info

      added the new deleted_by_developer enum value to the request property //////

    • info

      added the new deleted_by_developer enum value to the request property /////

    • info

      added the new deleted_by_developer enum value to the request property /////

    • info

      added the new deleted_by_developer enum value to the request property /////

    • info

      added the new deleted_by_developer enum value to the request property /////

    • info

      added the new invalid_account_number enum value to the request property //////

    • info

      added the new invalid_account_number enum value to the request property /////

    • info

      added the new invalid_account_number enum value to the request property /////

    • info

      added the new invalid_account_number enum value to the request property /////

    • info

      added the new invalid_account_number enum value to the request property /////

    • info

      added the new invalid_bank_validation enum value to the request property //////

    • info

      added the new invalid_bank_validation enum value to the request property /////

    • info

      added the new invalid_bank_validation enum value to the request property /////

    • info

      added the new invalid_bank_validation enum value to the request property /////

    • info

      added the new invalid_bank_validation enum value to the request property /////

    • info

      added the new plaid_item_error enum value to the request property //////

    • info

      added the new plaid_item_error enum value to the request property /////

    • info

      added the new plaid_item_error enum value to the request property /////

    • info

      added the new plaid_item_error enum value to the request property /////

    • info

      added the new plaid_item_error enum value to the request property /////

    • info

      added the new rejected_by_bank_provider enum value to the request property //////

    • info

      added the new rejected_by_bank_provider enum value to the request property /////

    • info

      added the new rejected_by_bank_provider enum value to the request property /////

    • info

      added the new rejected_by_bank_provider enum value to the request property /////

    • info

      added the new rejected_by_bank_provider enum value to the request property /////

    • info

      added the new requested_by_developer enum value to the request property //////

    • info

      added the new requested_by_developer enum value to the request property /////

    • info

      added the new requested_by_developer enum value to the request property /////

    • info

      added the new requested_by_developer enum value to the request property /////

    • info

      added the new requested_by_developer enum value to the request property /////

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional write-only property allOf[ExternalAccount]/oneOf[subschema #5: Pix -> subschema #4: Pix]/allOf[subschema #2]/br_code/document_number to the response with the status

    • info

      added the optional write-only property allOf[ExternalAccount]/oneOf[subschema #5: Pix -> subschema #4: Pix]/allOf[subschema #2]/pix_key/document_number to the response with the status

    • info

      removed from the /// response property oneOf list for the response status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required write-only property allOf[ExternalAccount]/oneOf[subschema #2: IBAN]/allOf[subschema #2]/iban/account_number to the response with the status

    • info

      added the required write-only property allOf[ExternalAccount]/oneOf[subschema #4: CLABE -> subschema #3: CLABE]/allOf[subschema #2]/clabe/account_number to the response with the status

    • info

      added the required write-only property allOf[ExternalAccount]/oneOf[subschema #5: Pix -> subschema #4: Pix]/allOf[subschema #2]/br_code/br_code to the response with the status

    • info

      added the required write-only property allOf[ExternalAccount]/oneOf[subschema #5: Pix -> subschema #4: Pix]/allOf[subschema #2]/pix_key/pix_key to the response with the status

    • info

      added the required write-only property allOf[ExternalAccount]/oneOf[subschema #6: GB -> subschema #5: GB]/allOf[subschema #2]/account/account_number to the response with the status

    • info

      added the required write-only property allOf[ExternalAccount]/oneOf[subschema #7: Bre-B -> subschema #6: Bre-B]/allOf[subschema #2]/account/bre_b_key to the response with the status