List all W-8BEN-E documents

GET

/v4/documents/w-8ben-e

GET

1 import { AboundClient, Abound } from "@withabound/node-sdk";
2 
3 const client = new AboundClient({ apiKey: "YOUR_API_KEY" });
4 await client.formW8BenE.list();

Play

1 [
2   {
3     "id": "documentId_sampleGyuBXlfAwo",
4     "createdAt": "2024-01-01T00:00:00.000Z",
5     "expiresAt": "2029-01-01T00:00:00.000Z",
6     "url": "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/FORM-W-8BEN-E.pdf",
7     "payee": {
8       "incorporationCountry": "GB",
9       "name": "Hooli",
10       "permanentResidenceAddress": {
11         "address": "43 Hilly Fields",
12         "country": "GB",
13         "address2": "Suite 32",
14         "city": "Lewisham",
15         "state": "London",
16         "postalCode": "SE13 7JN"
17       },
18       "foreignTin": "*******6C",
19       "foreignTinFingerprint": "tinFingerprint_sampleanXo4V9nL9",
20       "mailingAddress": {
21         "address": "256 Byron Street",
22         "country": "US",
23         "address2": "Suite 32",
24         "city": "Palo Alto",
25         "state": "CA",
26         "postalCode": "94306"
27       },
28       "tin": "*******11",
29       "tinFingerprint": "tinFingerprint_sample847jI1LwxF",
30       "tinType": "BUSINESS",
31       "tinVerificationId": "tinVerificationId_sample1b0E6efa89",
32       "tinVerificationStatus": "MATCH"
33     },
34     "formFields": {
35       "taxClassification": "CORPORATION",
36       "isCertified": true,
37       "isForeignTinNotRequired": false,
38       "taxTreatyBenefits": {
39         "residentCountry": "GB",
40         "claimedProvision": "7",
41         "rateOfWithholding": 0,
42         "incomeCode": "17",
43         "incomeType": "SERVICES",
44         "additionalConditions": "Independent personal services performed in the US"
45       },
46       "referenceNumbers": [
47         "123456789"
48       ],
49       "electronicSignature": {
50         "signature": "Hooli Representative",
51         "printedName": "Hooli Representative",
52         "signedAt": "2024-01-01T00:00:00.000Z",
53         "ipAddress": "127.0.0.1"
54       }
55     }
56   }
57 ]

Returns a list of W-8BEN-E documents.

Query parameters

pageintegerOptional

The specific page of results you’re requesting. Responses are limited to a maximum of 100 records.

payeeTinFingerprintstringOptional

Filters the list of documents based on the payee.tinFingerprint field.

payeeForeignTinFingerprintstringOptional

Filters the list of documents based on the payee.foreignTinFingerprint field.

userIdstringOptional

The unique identifier for a single end-user of your application.

Response

idstring

The unique identifier for the W-8BEN-E document.

createdAtdatetime

The date and time in ISO 8601 format when the W-8BEN-E document was created.

expiresAtdatetime

The date and time in ISO 8601 format when the W-8BEN-E is expired and requires re-collection.

urlstring

The URL to the W-8BEN-E document.

payeeobject

formFieldsobject

userIdstringOptional

The unique identifier for a single end-user of your application.

List all W-8BEN-E documents

Headers

Query parameters

Response

Errors