Create a W-8BEN-E

POST

/v4/documents/w-8ben-e

POST

1 curl -X POST https://sandbox-api.withabound.com/v4/documents/w-8ben-e \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "payee": {
6     "name": "Hooli",
7     "incorporationCountry": "GB",
8     "permanentResidenceAddress": {
9       "address": "43 Hilly Fields",
10       "country": "GB",
11       "address2": "Suite 32",
12       "city": "Lewisham",
13       "state": "London",
14       "postalCode": "SE13 7JN"
15     },
16     "tin": "111111111",
17     "foreignTin": "DQ123456C",
18     "mailingAddress": {
19       "address": "256 Byron Street",
20       "country": "US",
21       "address2": "Suite 32",
22       "city": "Palo Alto",
23       "state": "CA",
24       "postalCode": "94306"
25     }
26   },
27   "formFields": {
28     "taxClassification": "CORPORATION",
29     "isCertified": true,
30     "isForeignTinNotRequired": false,
31     "taxTreatyCode": "GB_17_INDEPENDENT_PERSONAL_SERVICES",
32     "referenceNumbers": [
33       "123456789"
34     ],
35     "electronicSignature": {
36       "signature": "Hooli Representative",
37       "printedName": "Hooli Representative",
38       "signedAt": "2024-01-01T00:00:00.000Z",
39       "ipAddress": "127.0.0.1"
40     }
41   }
42 }'

Play

200default

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

Creates a W-8BEN-E document and, if present, subsequently kicks off a TIN Verification. A TIN Verification will only kickoff if the name and TIN combo has not been seen before.

Request

This endpoint expects an object.

payeeobjectRequired

The payee (beneficial owner) completing the document.

formFieldsobjectRequired

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.

Create a W-8BEN-E

Headers

Request

Response

Errors