Skip to navigation

Bank account verification extension contract reference

View as Markdown

The bank account verification extension enables real-time verification of bank account information. This extension can only be used to verify U.S. bank accounts with American Bankers Association routing numbers.

With this extension, you can add special bank account data fields to documents. When a recipient fills out those fields, Docusign sends a request to an external bank account verification service. If the account information is not valid, the recipient is prompted to correct the data.

This extension verifies specific types of values. See Connected fields extension overview for information about an extension that can verify any type of value against an organization’s system of record.

You can include this extension when you register an extension app. If you register the extension app using a form, select the Data Verification extension in the form-based UI. Then select a verification type of Bank Account.

Bank account verification form-based registration

If you register the extension app using an app manifest file, set the extensions.template value in your app manifest to Verify.Version4.BankAccount.

This extension has one action. The action name you specify when you register an extension app depends on whether you register the app using a form or using an app manifest file. The app manifest file value listed here appears in the actions.template property.

Form-Based Action NameApp Manifest File Value
Verify Bank Account NumberVerify.Version4.BankAccount

You provide the details required for action execution when you register an extension app. See Update extension and action settings for information about defining actions using the form-based registration process. See Action schema for information about action properties in the app manifest file.

Action contracts

The bank account verification contract describes the parameters that Docusign will pass to the external bank verification service as well as the parameters expected in the response. You specify the URL for the bank verification service in the action definition in the form-based UI or in the extension app manifest.

Verify Bank Account Number is the label for this action that appears when you register an extension app using a form. If you register your extension app using an app manifest file, the actions.template property value for this action is Verify.Version4.BankAccount.

HTTP method

This action initiates a POST request to the external API service.

Request

{
"accountNumber": "A1234567890",
"accountType": "savings",
"routingNumber": "A1234567890"
}
PropertyTypeRequired?Description
accountNumberstringYesThe account number of the bank account.
accountTypestringYesThe type of bank account. Possible values:
  • checking
  • savings
routingNumberstringYesThe routing number of the bank account.

Response Successful case

{
"verified": true,
"responseCode": 'VERIFIED',
"providerResponseCode": 'OK',
}
Unsuccessful case
{
"verified": false,
"responseCode": 'NOT_VERIFIED',
"providerResponseCode": 'FAILED_BECAUSE_REASONS',
}
PropertyTypeOccurrenceDescription
verifiedbooleanRequiredWhether the bank account was successfully verified.
responseCodestringRequiredContains a code that indicates the type of response. If verification failed, this code will contain an error code.
providerResponseCodestringOptionalContains response code produced from the app indicating the reasons for success or failure.

Next steps