Request Path

Submit all document requests to the following path.

You will obtain the API endpoint after you register on your account page.

Headers

Each request must an OAuth2 tokan and your company Id, assigned by TaxStatus, in the header.

Query String Parameters

Query string parameters are not supported on this method.

/Document Request application/json

Post the following payload to retrieve the document in the request body.

Attributes

• companyId* The company Id of the company this call is on behalf of. If the call is not on behalf of another company, then the registered company Id TaxStatus assigned during the registration process used in the euid field in the header.
• tin* 9-digit tax id (no spaces or hypens) of the individual or company
• lastNameOrBusiness* The last name of the taxpayer or business name if business
• isCompany* Booliean value indicating if this call is for an individual or business
• docId* Id indicating which document to retrieve. This Id can be obtained either from the consent completed callback (if you are using callbacks). Or the response of the TAXPAYERS call, in the ConsentLink field, the value of req on the querystring. If the latter, you will need to append it to the document type. There are 3 different types of documents:
  • Identity - Driver's licenses or passports. Document type: Id
  • Authorization - The IRS form used in the authorization process. Document type: either 8821 or 4506

Example request body for the documnet method to retrieve a driver's license

Response Body application/json

Attributes

• Last4 The last 4 figits of the Tax Identification Number sent in the request
• LastNameOrBusiness The last name or business name of the taxpayer.
• DocId The document Id sent in the request.
• Status The status of the ID verification check.
  ID document types only.
• VerificationDate The date of the ID verification check.
  ID document types only.
• DLFirstName The first name on the drivers license.
  ID document types only.
• DLLastName The last name on the drivers license.
  ID document types only.
• Birthdate The status of the ID verification check.
  ID document types only.
• State The state that issued the drivers license.
  ID document types only.
• IssueDate The issue date of the drivers license.
  ID document types only.
• ExpirationDate The expiration date of the drivers license.
  ID document types only.
• Doc The document in base-64 string format.

Example response body for the documant method (drivers license)

Example response body for the documant method (authorization)

The reponse codes for the document call are standard HTML response codes.

Response Codes