Create a Form W-8BEN

The following is an example of creating a Form W-8BEN.


Generating a Form W-8BEN

To create a Form W-8BEN directly from our API you’ll need information about the Payee and the associated form fields values.

tin or tinFingerprint?

We allow you to pass either the plain text tin or a previously created tinFingerprint.

cURL
1curl --request POST \
2     --url https://sandbox-api.withabound.com/v4/documents/w-8ben \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '
6      {
7        "payee": {
8          "name": "Ada Lovelace",
9          "citizenshipCountry": "GB",
10          "tin": "111111111",
11          "foreignTin": "DQ123456C",
12          "dateOfBirth": "1986-03-23",
13          "permanentResidenceAddress": {
14            "address": "43 Hilly Fields",
15            "address2": "Suite 32",
16            "city": "Lewisham",
17            "state": "London",
18            "postalCode": "SE13 7JN",
19            "country": "GB"
20          },
21          "mailingAddress": {
22            "address": "256 Byron Street",
23            "address2": "Suite 32",
24            "city": "Palo Alto",
25            "state": "CA",
26            "postalCode": "94306",
27            "country": "US"
28          }
29        },
30        "formFields": {
31          "isForeignTinNotRequired": false,
32          "taxTreatyCode": "GB_17_INDEPENDENT_PERSONAL_SERVICES",
33          "referenceNumbers": ["1000001", "2000002"],
34          "isCertified": true
35          "electronicSignature": {
36          		"signature": "Ada Lovelace",
37          		"printedName": "Ada Lovelace",
38              "signedAt": "2024-01-01T00:00:00.000Z",
39              "ipAddress": "127.0.0.1"
40          }
41        },
42        "userId": "userId_sampleXGMFnhOpeR"
43      }

Response

The response will contain a unique documentId, the createdAt timestamp, the expiredAt timestamp. url to the generated pdf, and the withholdingRate.

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

Automatic Tin Verification

It’s important to note that if the combination of the Payee’s name and tin has not been seen before on the Abound platform, a Tin Verification will automatically be created. In the event that a new Tin Verification was created, a tinVerificationId will be returned in the response nested in the payee and/or the payer object(s).