Skip to navigation

Business FEIN verification extension contract reference

View as Markdown

This extension enables real-time verification of a business entity’s FEIN (Federal Employer Identification Number). Your extension app must call an external service that verifies whether the business entity exists and is registered in government databases. This extension can only be used to verify U.S. businesses associated with an FEIN issued by the Internal Revenue Service (IRS).

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 Business Entity.

Business entity extension in 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.Version2.BusinessEntity.

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 Business EntityVerify.Version2.BusinessEntity

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

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

Verify Business Entity 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.Version1.BusinessEntity.

HTTP method

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

Request

{
"business": "My Cool New Business",
"fein": "12-3456789"
}
PropertyTypeDescription
businessstringThe name of the business entity.
feinstringThe FEIN (also known as EIN or Federal Tax Identification Number) of the business entity.

Response

Successful case

{
"verified": true,
"responseCode": 'VERIFIED',
"providerResponseCode": 'OK',
}
Unsuccessful case
{
"verified": false,
"responseCode": 'NOT_VERIFIED',
"providerResponseCode": 'FAILED_BECAUSE_REASONS',
}
PropertyTypeOccurrenceDescription
verifiedbooleanRequiredWhether the business entity 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