Catalog

List standard forms available to clone

get/api/v1/catalog/forms

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/catalog/forms
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Response

idstring required
slugstring required
titlestring required
jurisdictionstring nullable
descriptionstring nullable
publishedRevisionstring required

The published version currently available for cloning

publishedVersionIdstring required

ID of the published version to clone from

fieldCountnumber required

Fields mapped on the published version.

signerRoleCountnumber required

Signer roles the published version defines.

sourceUrlstring nullable

The publisher's own URL this version's PDF was taken from. Every version published from now on records one, so this is null only for a form published before provenance became a publish requirement.

sourceSha256string nullable

SHA-256 of the exact PDF bytes Korala ships for this version. Download the form from sourceUrl, hash it, and compare to verify the catalog against its government source.

Example response

[
  {
    "slug": "irs-w9",
    "sourceUrl": "https://www.irs.gov/pub/irs-pdf/fw9.pdf"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.