Skip to navigation
REST API EndpointsCustomer Applications

Sign User Document

View as Markdown

Record a user’s signature on a funding-disclosure document.

Available to: All authenticated users

Environments: Live

Rate Limit: 10 requests per hour, 30-second back-off, counts all requests

Call once per document, after the user has read the PDF returned by downloadUserDocumentPreview. A success carries userSignedDocumentId and successHashCode.

signature must match the full name on the applicant’s contact record; a mismatch is rejected rather than stored. Send date as MM/DD/YYYY, and pdfFields as {} for both funding disclosures.

allowMultiple controls what happens when the user has already signed that template. Omitted or false, a second attempt is refused. Set to true, a second signature is recorded alongside the first — which is what the add-a-payment-method flows rely on, since they re-collect the payment processor authorization each time.

Warning: Once this call returns a userSignedDocumentId, the signature is stored. If your confirming read of userSignedDocumentLDependents does not show it yet, retry the read. Calling this endpoint again with allowMultiple: true records a duplicate signature rather than repairing anything.

Not every template can be signed here. A template that is not enabled for generic signing is refused by name.

Common Failure Scenarios

  • The signature does not match the applicant’s full name on file
  • The template is not enabled for generic signing
  • The user already signed the template and allowMultiple was not set
  • The agreementDocumentTemplateId belongs to another clearing house

Error Messages

MessageResponseTrigger
"Signature should be the same as full name of the applicant"200 (in errorText)signature does not match the contact record. The comparison tolerates accents.
"This endpoint does not support signing <template name>"200 (in errorText)The template is not enabled for generic signing.
"User already has a signed <template name>."200 (in errorText)The template is already signed and allowMultiple was omitted or false.
"Access is denied"401The session is not permitted to sign documents.

Related Endpoints

  • Use downloadUserDocumentPreview to display the document before collecting the signature.
  • Use userSignedDocumentLDependents to confirm the signature was stored.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
signaturestringRequired<=8192 characters
datestringRequired<=8192 characters
agreementDocumentTemplateIdlongRequired
pdfFieldsobjectRequired
allowMultiplebooleanOptional
asCustomerApplicationDocumentobjectOptional

Response

SignUserDocumentResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

successHashCodelongOptional
userSignedDocumentIdlongOptional