Skip to navigation

User Signed Document L Dependents

View as Markdown

List the documents a user has signed.

Available to: All authenticated users

Environments: Live

Rate Limit: No endpoint-specific limit

Pass the user’s ID as the masterids query parameter. Each record carries the signed document’s documentName, its agreementDocumentTemplateId, and the time it was signed.

Use this before a funding flow to decide which disclosures the user still owes, and again after signUserDocument to confirm a signature was stored. Match on documentName against the names the flow requires.

A previously signed document satisfies the requirement, with one exception: adding a payment method re-collects the payment processor authorization every time, so that document is presented again even when this endpoint already lists it.

Warning: A signed record is not scoped to a clearing house. Where the same document name exists for more than one clearing house, a record from any of them matches, so this endpoint cannot tell you which clearing house’s template was signed.

An empty array means the user has signed nothing visible to the caller. Treat that as “all required disclosures outstanding,” not as an error.

Related Endpoints

  • Use agreementDocumentTemplateList to resolve a document name to the template ID for this account’s clearing house.
  • Use downloadUserDocumentPreview and signUserDocument to complete an outstanding disclosure.

Authentication

AuthorizationBearer

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

Query parameters

masteridslist of longsRequired
List of User entity IDs

Response

UserSignedDocument
userIdlong
timestampdatetime
agreementDocumentTemplateIdlong
documentNamestring<=64 characters
idlongOptional
signedTimestampdatetimeOptional