Back
v1.99.6: Document Type - Expiration Policy (2026-10-22)

What's Changed


GET /documentTypes/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property expirationPolicy (string)

      Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      Enum values:

      • auto
      • never
    • Changed property expiresInMonths (number)

      Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

PATCH /documentTypes/{id}
Request:

Changed content type : application/json

  • Added property expirationPolicy (string)

    Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

  • Changed property expiresInMonths (number)

    Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property expirationPolicy (string)

      Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

    • Changed property expiresInMonths (number)

      Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /scenarios
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Scenario included relations

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property expirationPolicy (string)

        Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      • Changed property expiresInMonths (number)

        Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

POST /scenarios
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property expirationPolicy (string)

        Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      • Changed property expiresInMonths (number)

        Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /scenarios/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property expirationPolicy (string)

        Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      • Changed property expiresInMonths (number)

        Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

PATCH /scenarios/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentTypes (array)

      Scenario document types

      Changed items (object):

      • Added property expirationPolicy (string)

        Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      • Changed property expiresInMonths (number)

        Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /candidateDocumentTypes/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documentType (object)

      • Added property expirationPolicy (string)

        Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      • Changed property expiresInMonths (number)

        Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /registration-pages
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documents (array)

      Related documents

      Changed items (object):

      • Changed property documentType (object)

        • Added property expirationPolicy (string)

          Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

        • Changed property expiresInMonths (number)

          Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /registration-pages/{id}
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Changed property documents (array)

      Related documents

      Changed items (object):

      • Changed property documentType (object)

        • Added property expirationPolicy (string)

          Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

        • Changed property expiresInMonths (number)

          Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /candidateDocumentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object): > Candidate Document Type properties

    • Changed property documentType (object)

      • Added property expirationPolicy (string)

        Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

      • Changed property expiresInMonths (number)

        Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

POST /documentTypes
Request:

Changed content type : application/json

  • Added property expirationPolicy (string)

    Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

  • Changed property expiresInMonths (number)

    Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    • Added property expirationPolicy (string)

      Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

    • Changed property expiresInMonths (number)

      Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.

GET /documentTypes
Return Type:

Changed response : 200 OK

Request was successful

  • Changed content type : application/json

    Changed items (object):

    • Added property expirationPolicy (string)

      Whether documents of the type expire. "auto": a document gets the status expired once its expiration date (parsed, or from expiresInMonths) has passed, checked nightly. "never": the expiration date is still set, but the document never expires. Changing the policy does not change any status already set: expired documents stay expired, and switching back to "auto" expires the documents already past their date at the next nightly check.

    • Changed property expiresInMonths (number)

      Default expiration time: when no expiration date is parsed from a document, its expiration date is set to this number of months after the document is processed. Null or 0 sets no date. Applied under both expiration policies.