GuidesAPI ReferenceChangelog
Abound Dashboard

Create a Form W-8BEN

Suggest Edits

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 --request POST \
     --url https://sandbox-api.withabound.com/v4/documents/w-8ben \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
      {
        "payee": {
          "name": "Ada Lovelace",
          "citizenshipCountry": "GB",
          "tin": "111111111",
          "foreignTin": "DQ123456C",
          "dateOfBirth": "1986-03-23",
          "permanentResidenceAddress": {
            "address": "43 Hilly Fields",
            "address2": "Suite 32",
            "city": "Lewisham",
            "state": "London",
            "postalCode": "SE13 7JN",
            "country": "GB"
          },
          "mailingAddress": {
            "address": "256 Byron Street",
            "address2": "Suite 32",
            "city": "Palo Alto",
            "state": "CA",
            "postalCode": "94306",
            "country": "US"
          }
        },
        "formFields": {
          "isForeignTinNotRequired": false,
          "taxTreatyCode": "GB_17_INDEPENDENT_PERSONAL_SERVICES",
          "referenceNumbers": ["1000001", "2000002"],
          "isCertified": true
          "electronicSignature": {
          		"signature": "Ada Lovelace",
          		"printedName": "Ada Lovelace",
              "signedAt": "2024-01-01T00:00:00.000Z",
              "ipAddress": "127.0.0.1"
          }
        },
        "userId": "userId_sampleXGMFnhOpeR"
      }

Response

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

{
    "id": "documentId_samplexEM8PRV7sh",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "expiresAt": "2028-01-01T00:00:00.000Z",
    "url": "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com/documents/FORM-W_8BEN.pdf",
    "withholdingRate": 0,
    "payee": {
        "name": "Ada Lovelace",
        "citizenshipCountry": "GB",
        "tin": "*******00",
        "tinType": "INDIVIDUAL",
        "tinFingerprint": "tinFingerprint_samplehy2BWO6JJG",
        "tinVerificationId": "tinVerificationId_sample41SD71AV8f",
        "tinVerificationStatus": "MATCH",
        "foreignTin": "*******6C",
        "foreignTinFingerprint": "tinFingerprint_sampleanXo4V9nL9",
        "dateOfBirth": "1986-03-23",
        "permanentResidenceAddress": {
            "address": "43 Hilly Fields",
            "address2": "Suite 32",
            "city": "Lewisham",
            "state": "London",
            "postalCode": "SE13 7JN",
            "country": "GB"
        },
        "mailingAddress": {
            "address": "256 Byron Street",
            "address2": "Suite 32",
            "city": "Palo Alto",
            "state": "CA",
            "postalCode": "94306",
            "country": "US"
        }
    },
    "formFields": {
        "taxClassification": "INDIVIDUAL",
        "taxTreatyCode": "GB_17_INDEPENDENT_PERSONAL_SERVICES",
        "taxTreatyBenefits": {
            "residentCountry": "GB",
            "claimedProvision": "7",
            "rateOfWithholding": 0,
            "incomeCode": "17",
            "incomeType": "OTHER",
            "additionalConditions": "Independent personal services"
        },
        "referenceNumbers": [
            "1000001",
            "2000002"
        ],
        "isCertified": true,
        "electronicSignature": {
            "signature": "Ada Lovelace",
            "printedName": "Ada Lovelace",
            "signedAt": "2024-01-01T00:00:00.000Z",
            "ipAddress": "127.0.0.1"
        }
    },
    "userId": "userId_sampleXGMFnhOpeR"
}

📘

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).

Updated 6 days ago