API ReferenceW-8BEN

List all W-8BEN documents

Returns a list of W-8BEN documents.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

OK
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
userIdstring or null

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

Errors