List all W-8BEN documents

GET
Returns a list of W-8BEN documents.

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

This endpoint returns a list of objects.
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
userIdstringOptional
The unique identifier for a single end-user of your application.

Errors