Skip to content

documentUrl

Resolve a partner-facing documentId (received in a document.* webhook event) to a short-lived URL the partner can use to fetch the document.

documentId is prefixed:

  • hs_<signature_request_id> — HelloSign-routed contracts
  • doc_<Document.uuid> — inspection reports and other partner-visible Document rows

Returns NOT_FOUND in all access-denied cases — whether the document does not exist, the calling partner is not associated with the document’s lead, or the document’s type is outside the partner-fetchable allowlist. The cases are deliberately not disambiguated so a partner cannot use this endpoint to probe for the existence of documents they cannot access.

documentUrl(input: DocumentUrlInput!): DocumentUrlResponse!
ArgumentTypeDescription
inputDocumentUrlInput!

Returns DocumentUrlResponse!.