List all W-8BEN documents

GET

/v4/documents/w-8ben

Returns a list of W-8BEN 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 document.

createdAtdatetime

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

expiresAtdatetime

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

urlstring

The URL to the W-8BEN document.

payeeobject

formFieldsobject

userIdstringOptional

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

Errors

GET

1 curl https://sandbox-api.withabound.com/v4/documents/w-8ben \
2      -H "Authorization: Bearer <apiKey>"

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

Built with

1	curl https://sandbox-api.withabound.com/v4/documents/w-8ben \
2	-H "Authorization: Bearer <apiKey>"

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