Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Abound W-8BEN API

The W-8BEN API from Abound — 2 operation(s) for w-8ben.

Abound W-8BEN API is one of 13 APIs that Abound publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include W-8BEN. The published artifact set on APIs.io includes an OpenAPI specification and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 25 schemas. It is described by OpenAPI 3.1.0, at version 4.

Requests are made against 2 base URLs: https://production-api.withabound.com, https://sandbox-api.withabound.com.

3 operations 2 paths 25 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4
Base URL
https://production-api.withabound.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Abound W-8BEN API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token. The token is the concatenation of your Abound appId and appSecret separated by a period, e.g. appIdxxx.appSecretyyy.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

W-8BEN 3
GET
/v4/documents/w-8ben
List all W-8BEN documents
formW8benList 4 params → 200400401404500
POST
/v4/documents/w-8ben
Create a W-8BEN
formW8benCreate body → 200400401404500
GET
/v4/documents/w-8ben/{documentId}
Retrieve a W-8BEN
formW8benRetrieve 1 param → 200400401404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are W8BenSchema (7 properties), W8BenBeneficialOwnerRequestSchema (7 properties), TaxTreatyBenefitsSchema (6 properties), W8BenFormFieldsSchema (6 properties). Each schema is shown below with its type and property counts.

W8BenBeneficialOwnerSchema
W8BenBeneficialOwnerRequestSchema
object
The payee (beneficial owner) completing the document.
7 properties 4 required
TaxTreatyBenefitsSchema
object
The tax treaty benefits the payee is claiming.
6 properties 5 required
W8BenFormFieldsSchema
object
6 properties 2 required
TaxTreatyAboundCodeEnum
string
The tax treaty code the payee is claiming.
TinTypeEnum
string
The type of the TIN. INDIVIDUAL refers to SSNs, ITINs, or ATINs. While BUSINESS refers to EINs.
ForeignTinFingerprint
string
The unique token that points to a foreign TIN.
Page
integer
The specific page of results you're requesting. Responses are limited to a maximum of 100 records.
ElectronicSignatureOfPayeeSchema
object
The electronic signature of the payee.
4 properties 4 required
TinFingerprint
string
Your unique token that points to a TIN.
TaxTreatyIncomeCodeEnum
string
ErrorBadRequestSchema
object
1 property 1 required
PayeeForeignTinFingerprint
string
Filters the list of documents based on the payee.foreignTinFingerprint field.
UserId
string
The unique identifier for a single end-user of your application.
ForeignAddressSchema
object
6 properties 2 required
TinVerificationStatusEnum
string
The status of the TIN Verification.
W8BenFormFieldsRequestSchema
object
5 properties 1 required
AddressSchema
object
6 properties 2 required
DocumentId
string
The unique identifier for an existing document.
PayeeTinFingerprint
string
Filters the list of documents based on the payee.tinFingerprint field.
DefaultErrorSchema
object
1 property 1 required
W8BenSchema
object
7 properties 6 required
TinVerificationId
string
The unique identifier for the TIN Verification.
W8BenRequestSchema
object
3 properties 2 required
ErrorBadRequestSchemaErrorsItem
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abound-w-8ben-api-openapi.yml Raw ↑

Other APIs Abound publishes across the network.

Abound 1099-INT API
Abound 1099-K API
Abound 1099-MISC API
Abound 1099-NEC API
Abound Access Tokens API
Abound Electronic Delivery Consents API
Abound Mailings API
Abound Tax Treaties API
Abound TIN Verifications API
Abound Users API
Abound W-8BEN-E API
Abound W-9 API