Search
K
Document Generator API

Document Generator API

3.0OAS 3.0
API Base URL
Security
BearerAuth (http)

JWT Bearer token for Kong Dev Portal authentication. Enter your token in the format: Bearer

ShareFileOAuth2 (oauth2)

Authorization Code OAuth Flow

Authorize URL: https://auth.sharefiletest.io/connect/authorize

Token URL: https://auth.sharefiletest.io/connect/token

Scopes:

  • docgen:all.full - Full access to Doc Gen APIs.
  • docgen:doctemplate.packaging - Doc Template Packaging APIs Access
  • docgen:doctemplate.template-provider - Document Templates full access to template provider
  • docgen:doctemplate.permanentdelete - Access to permanently delete document template and metadata

Container health check

Returns 200 OK if the container is healthy.

get
/healthcheck/container

Response

200 application/json

Container is healthy

statusstring

Example:ok

200 application/json

/v1/compliance/delete

delete
/v1/compliance/delete

Body

PermanentDeleteRequest

* Additional properties are NOT allowed.
resourceIdstring | null

Response

application/json

Success

PermanentDeleteResponse

PermanentDeleteResponseobject
* Additional properties are NOT allowed.
application/json

CreateDocumentFromTemplateAsync

post
/v1/documents

Body

CreateDocumentRequest

* Additional properties are NOT allowed.
documentTemplateRIDstring | null
namestring | null
containerRIDstring | null
settingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signatureSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
variableDataobject | null

Response

application/json

Created

DocumentResponse

* Additional properties are NOT allowed.
ridstring | null
containerRIDstring | null
templateRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
parentIdstring | null
accountIdstring | null
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
settingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signatureSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json

GetDocumentByIdAsync

get
/v1/documents/{documentRID}

Path Parameters

documentRIDstringrequired

Response

application/json

Success

DocumentResponse

* Additional properties are NOT allowed.
ridstring | null
containerRIDstring | null
templateRIDstring | null
namestring | null
creatorobject
* Additional properties are NOT allowed.
Show Child Parameters
parentIdstring | null
accountIdstring | null
fileobject
* Additional properties are NOT allowed.
Show Child Parameters
rolesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
fieldsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
settingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signatureSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
signerSequencingboolean | null
createdAtstring | null(date-time)
updatedAtstring | null(date-time)
variablesarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json