{
  "service": "Creditcrest Sign",
  "version": "creditcrest-sign-1",
  "method": "creditcrest-click-to-sign",
  "stores": "nothing",
  "what": "Signing for any document. You ask for a signature and get a link; the signer reads the document, draws their signature, types their name and agrees; you get the evidence back — the drawing as strokes, sealed with the rest with Creditcrest’s key — with a certificate of signing, as a page or a PDF. Creditcrest keeps none of it, and anyone holding the evidence can have it checked.",
  "price": "A$0.55 a completed signature. The price is what you pay: GST is never added on top. A request nobody signs costs nothing, and neither does a check. A contract signed in a hosted borrower account is included.",
  "endpoints": {
    "POST /v1/sign/requests": {
      "what": "Ask for a signature. Answers with the link to send the signer: the request travels sealed inside it, so nothing is stored.",
      "body": {
        "document": "{ \"html\": \"…\" } — travels in the link; or { \"sha256\": \"…\", \"url\": \"https://…\" } for a document you host, such as a PDF",
        "title": "what the signer sees it called",
        "signer": "{ \"name\": \"the full name they must type\", \"email\" | \"mobile\": \"one you hold, for them to confirm\" } — hashed on arrival",
        "consent": "{ \"text\", \"version\" } — the words they agree to; neutral words if left out",
        "expiresInDays": "1 to 30; 7 if left out",
        "returnUrl": "https:// — where the signer goes afterwards, with ?sign=<evidence token>: a page here says it is signed and links there, naming its host. With a live key, on your own website (or under it), your own domain on Creditcrest, or a host Creditcrest has added to your configuration; with a test or sandbox key, any https address",
        "requireDrawn": "true — the signer must draw their signature as well as type their name; if left out, your configuration’s signing.requireDrawn, or drawing is the signer’s choice"
      }
    },
    "POST /v1/sign/evidence": {
      "what": "Open the evidence token a signer brought back to your return address: the evidence, its seal, the check, and a certificate of signing to keep. Only the lender that asked can open it.",
      "body": {
        "token": "the sign= value"
      }
    },
    "POST /v1/sign/verify": {
      "what": "Check evidence and its seal, and the document if you send it: valid, or exactly why not, each reason with a code.",
      "body": {
        "evidence": "as returned",
        "seal": "as returned",
        "document": "{ \"html\" } or { \"sha256\" } — optional"
      }
    },
    "POST /v1/sign/certificate": {
      "what": "The certificate of signing as a PDF, to keep with the document: the drawn signature as drawn, the typed name, the fingerprints and the seal. Made only for evidence whose seal checks; answers application/pdf.",
      "body": {
        "evidence": "as returned",
        "seal": "as returned"
      }
    }
  },
  "pages": {
    "/sign": "what it is, and a demonstration",
    "/sign/verify": "check a signature by hand"
  }
}