[{"data":1,"prerenderedAt":3297},["ShallowReactive",2],{"content-page-\u002Fdocs\u002Fverified-documents":3,"api-docs-metadata":2454,"icon-harvest":3281},{"id":4,"title":5,"body":6,"description":2444,"extension":2445,"meta":2446,"navigation":2449,"path":2450,"seo":2451,"stem":2452,"__hash__":2453},"all\u002Fdocs\u002Fverified-documents.md","Verified documents",{"type":7,"value":8,"toc":2423},"minimark",[9,13,27,30,33,94,103,108,115,226,229,234,245,255,258,324,344,354,358,369,373,376,468,471,488,504,507,510,517,547,550,561,565,568,573,654,694,697,702,706,712,732,735,739,746,758,764,777,780,783,786,797,800,803,835,838,842,846,849,1054,1089,1096,1099,1109,1200,1217,1479,1486,1490,1496,1508,1881,2008,2025,2035,2042,2046,2055,2296,2322,2325,2380,2387,2391,2419],[10,11,5],"h1",{"id":12},"verified-documents",[14,15,16,17,21,22,26],"p",{},"Turn on verified documents for a template and every real render of it issues a ",[18,19,20],"strong",{},"document",": a record with its own public verify page at ",[23,24,25],"code",{},"https:\u002F\u002Fbannx.com\u002Fverify\u002F\u003Cid>",". You put that link in a QR code on the design. Whoever holds the printed certificate, the card or the badge can show it, and whoever scans the code sees whether it is genuine, who it was issued to and who issued it.",[14,28,29],{},"You don't build or host anything. bannx keeps the record, serves the page, and lets you revoke a document later.",[14,31,32],{},"There are three kinds:",[34,35,36,52],"table",{},[37,38,39],"thead",{},[40,41,42,46,49],"tr",{},[43,44,45],"th",{},"Kind",[43,47,48],{},"For",[43,50,51],{},"Photo on the verify page",[53,54,55,69,82],"tbody",{},[40,56,57,63,66],{},[58,59,60],"td",{},[18,61,62],{},"Certificate",[58,64,65],{},"Course completion, awards, training and CPD, diplomas",[58,67,68],{},"No",[40,70,71,76,79],{},[58,72,73],{},[18,74,75],{},"ID card",[58,77,78],{},"Membership, staff, student and volunteer cards",[58,80,81],{},"Yes, optional",[40,83,84,89,92],{},[58,85,86],{},[18,87,88],{},"Event badge",[58,90,91],{},"Conference badges and name tags",[58,93,81],{},[14,95,96,97,102],{},"Issuing documents is free. Each render costs its normal ",[98,99,101],"a",{"href":100},"\u002Fdocs\u002Frendering#credits","credits",".",[104,105,107],"h2",{"id":106},"turn-it-on","Turn it on",[14,109,110,111,114],{},"Open the template in the editor, then ",[18,112,113],{},"Template settings → Verified documents",":",[34,116,117,127],{},[37,118,119],{},[40,120,121,124],{},[43,122,123],{},"Setting",[43,125,126],{},"What it does",[53,128,129,139,148,158,180,190,204],{},[40,130,131,136],{},[58,132,133],{},[18,134,135],{},"Issue verified documents",[58,137,138],{},"The switch. Off, renders issue nothing.",[40,140,141,145],{},[58,142,143],{},[18,144,45],{},[58,146,147],{},"Certificate, ID card or Event badge.",[40,149,150,155],{},[58,151,152],{},[18,153,154],{},"Title",[58,156,157],{},"Shown at the top of the verify page, e.g. \"Certificate of completion\" (up to 80 characters). Without one, the page shows the kind.",[40,159,160,165],{},[58,161,162],{},[18,163,164],{},"Public fields",[58,166,167,168,171,172,175,176,102],{},"The variables the verify page shows, each with a label: ",[23,169,170],{},"recipient"," as \"Name\", ",[23,173,174],{},"course"," as \"Course\". Up to 12. Only these are public; see ",[98,177,179],{"href":178},"#privacy","Privacy",[40,181,182,187],{},[58,183,184],{},[18,185,186],{},"Photo",[58,188,189],{},"ID cards and badges: an image variable holding the holder's photo.",[40,191,192,197],{},[58,193,194],{},[18,195,196],{},"Expiry",[58,198,199,200,203],{},"None, a date variable (",[23,201,202],{},"2027-06-30",", valid to the end of that day, UTC; or a full ISO date-time), or a number of days after issue (1 to 3650).",[40,205,206,211],{},[58,207,208],{},[18,209,210],{},"Subject key",[58,212,213,214,217,218,221,222,102],{},"A variable that identifies the holder, such as ",[23,215,216],{},"email"," or ",[23,219,220],{},"memberId",". It decides when a render reuses or replaces a document; see ",[98,223,225],{"href":224},"#renewals-and-reuse","Renewals and reuse",[14,227,228],{},"Every variable the setting names must be a variable the template declares, and the photo must be an image variable. Otherwise saving the setting is refused with the problem named.",[230,231,233],"h3",{"id":232},"put-the-link-in-a-qr-code","Put the link in a QR code",[14,235,236,237,240,241,244],{},"Add a ",[18,238,239],{},"QR code"," layer (Insert → QR code) and set its ",[18,242,243],{},"Value"," to:",[246,247,252],"pre",{"className":248,"code":250,"language":251},[249],"language-text","{{ credential.url }}\n","text",[23,253,250],{"__ignoreMap":254},"",[14,256,257],{},"Every issued document then prints its own verify link. Two more values are there for the design:",[34,259,260,272],{},[37,261,262],{},[40,263,264,266,269],{},[43,265,243],{},[43,267,268],{},"Example",[43,270,271],{},"Use it for",[53,273,274,289,304],{},[40,275,276,281,286],{},[58,277,278],{},[23,279,280],{},"{{ credential.url }}",[58,282,283],{},[23,284,285],{},"https:\u002F\u002Fbannx.com\u002Fverify\u002F4kT9…",[58,287,288],{},"The QR code's value, or a printed link",[40,290,291,296,301],{},[58,292,293],{},[23,294,295],{},"{{ credential.code }}",[58,297,298],{},[23,299,300],{},"4KT9XW2P",[58,302,303],{},"8 characters to print beside the QR, so a person can quote the document",[40,305,306,311,317],{},[58,307,308],{},[23,309,310],{},"{{ credential.id }}",[58,312,313,316],{},[23,314,315],{},"4kT9xw2pQ…"," (22 letters and digits)",[58,318,319,320],{},"The full public id, for the ",[98,321,323],{"href":322},"#check-a-document-from-code","verify API",[14,325,326,329,330,333,334,336,337,340,341,343],{},[23,327,328],{},"credential"," is a reserved name, like ",[23,331,332],{},"brand",". A ",[23,335,328],{}," value sent in a request's ",[23,338,339],{},"variables"," is ignored, so nobody can print another document's link into yours. If the template itself declares a variable called ",[23,342,328],{},", that variable wins and the QR will not point at a verify page: rename it.",[14,345,346,347,349,350,353],{},"In the editor canvas, previews and anywhere else nothing is issued, these values are samples: ",[23,348,280],{}," is ",[23,351,352],{},"https:\u002F\u002Fbannx.com\u002Fverify\u002Fsample",", an explanatory page, so the QR still lays out and scans.",[230,355,357],{"id":356},"publish-again","Publish again",[14,359,360,361,364,365,368],{},"API renders use the ",[18,362,363],{},"published"," version of a template, and so does its setting. After you turn verified documents on (or change the setting), publish the template again. Until then, renders from the API and MCP issue nothing, unless they pass ",[23,366,367],{},"\"draft\": true",". A template that was never published uses its draft either way. Bulk runs read the template as it is now.",[104,370,372],{"id":371},"what-issues-a-document","What issues a document",[14,374,375],{},"A document is issued only when a real file goes out:",[34,377,378,388],{},[37,379,380],{},[40,381,382,385],{},[43,383,384],{},"Issues a document",[43,386,387],{},"Does not (sample values)",[53,389,390,405,420,440,451],{},[40,391,392,402],{},[58,393,394,397,398,401],{},[23,395,396],{},"POST \u002Fapi\u002Fv1\u002Ftemplates\u002F:id\u002Frender"," and the API-key ",[23,399,400],{},"GET"," render",[58,403,404],{},"The editor canvas and previews",[40,406,407,417],{},[58,408,409,412,413],{},[23,410,411],{},"template_render"," over ",[98,414,416],{"href":415},"\u002Fdocs\u002Fintegrations\u002Fmcp","MCP",[58,418,419],{},"Thumbnails and OG images",[40,421,422,429],{},[58,423,424,428],{},[98,425,427],{"href":426},"\u002Fdocs\u002Frendering#bulk-rendering","Bulk runs",": one per row",[58,430,431,435,436,439],{},[98,432,434],{"href":433},"\u002Fdocs\u002Frendering#signed-image-urls","Signed image URLs"," (",[23,437,438],{},"\u002Fr\u002F…",")",[40,441,442,448],{},[58,443,444,447],{},[18,445,446],{},"Download"," on the template's page",[58,449,450],{},"Embeds and public forms",[40,452,453,465],{},[58,454,455,459,460,464],{},[98,456,458],{"href":457},"\u002Fdocs\u002Fintegrations\u002Fzapier","Zapier"," and ",[98,461,463],{"href":462},"\u002Fdocs\u002Fintegrations\u002Fn8n","n8n"," renders, which go through the Render API",[58,466,467],{},"Downloads of someone else's public template from the gallery",[14,469,470],{},"Workflows have no render step of their own; a workflow issues a document when it calls the Render API.",[14,472,473,474,476,477,480,481,487],{},"A render that fails issues nothing. A bulk row that fails issues nothing, and a bulk job whose ZIP or PDF never gets delivered issues nothing for any row. Every API-key ",[23,475,400],{}," render issues (and is charged), so don't put one in an ",[23,478,479],{},"\u003Cimg>"," tag that loads on every view. A POST retried with the same ",[98,482,484],{"href":483},"\u002Fdocs\u002Frendering#retrying-safely",[23,485,486],{},"Idempotency-Key"," returns the first answer, with the same document.",[14,489,490,491,495,496,499,500,503],{},"When the space's documents are ",[98,492,494],{"href":493},"#reports-and-suspension","suspended",", renders of templates with verified documents on are refused with ",[23,497,498],{},"403"," ",[23,501,502],{},"CREDENTIALS_SUSPENDED",". Templates without them keep rendering.",[104,505,225],{"id":506},"renewals-and-reuse",[14,508,509],{},"Without a subject key, every render issues a new document.",[14,511,512,513,516],{},"With a subject key, bannx keeps ",[18,514,515],{},"one current document per holder"," of a template:",[518,519,520,531,541],"ul",{},[521,522,523,526,527,530],"li",{},[18,524,525],{},"Same holder, same public fields, same photo and expiry, still valid:"," the render reuses the existing document. Same id, same verify link, ",[23,528,529],{},"reused: true"," in the response. Re-sending a lost certificate does not create a second one.",[521,532,533,536,537,540],{},[18,534,535],{},"Same holder, something changed"," (a corrected name, a new grade, a new expiry date): a new document is issued. The old one becomes ",[18,538,539],{},"Replaced"," and its page links to the new one. This happens only once the new file is rendered, so a failed renewal never invalidates the old document.",[521,542,543,546],{},[18,544,545],{},"Same holder, document expired:"," a new document is issued with a new expiry. This is how you renew a yearly membership card: render it again.",[14,548,549],{},"With an expiry of a number of days, a reused document keeps its first expiry date. Re-rendering does not extend it; a render after it expires issues the renewal.",[14,551,552,553,556,557,102],{},"In a bulk run, a ",[23,554,555],{},"_credentialKey"," column (or JSON key) sets each row's holder and overrides the subject key variable. See ",[98,558,560],{"href":559},"#bulk","Bulk",[104,562,564],{"id":563},"the-verify-page","The verify page",[14,566,567],{},"Scanning the QR code opens the document's page. It is made for a phone, and it is not indexed by search engines. It shows:",[518,569,570],{},[521,571,572],{},"the status, in a banner:",[34,574,575,588],{},[37,576,577],{},[40,578,579,582,585],{},[43,580,581],{},"Status",[43,583,584],{},"Banner",[43,586,587],{},"Meaning",[53,589,590,603,616,629,642],{},[40,591,592,597,600],{},[58,593,594],{},[23,595,596],{},"valid",[58,598,599],{},"Valid document",[58,601,602],{},"Issued through bannx and not revoked.",[40,604,605,610,613],{},[58,606,607],{},[23,608,609],{},"expired",[58,611,612],{},"Expired",[58,614,615],{},"Genuine, but past its expiry date.",[40,617,618,623,626],{},[58,619,620],{},[23,621,622],{},"revoked",[58,624,625],{},"Revoked",[58,627,628],{},"The issuer withdrew it. The reason they gave is shown.",[40,630,631,636,639],{},[58,632,633],{},[23,634,635],{},"replaced",[58,637,638],{},"Replaced by a newer document",[58,640,641],{},"The issuer issued an updated version; the page links to it.",[40,643,644,648,651],{},[58,645,646],{},[23,647,494],{},[58,649,650],{},"Issuer suspended",[58,652,653],{},"bannx suspended the issuer. The page shows no fields, photo or preview.",[518,655,656,659,671,674,685],{},[521,657,658],{},"the title or kind, the public fields, the photo (ID cards and badges), and the issue and expiry dates;",[521,660,661,662,665,666,670],{},"the issuer: your space's name and logo, with ",[18,663,664],{},"Verified issuer: yourdomain.com"," when you have ",[98,667,669],{"href":668},"#verified-issuer","verified a domain",", else \"bannx has not confirmed this issuer's identity\";",[521,672,673],{},"the document as it was rendered, for PNG and WebP renders;",[521,675,676,677,680,681,684],{},"a ",[18,678,679],{},"document fingerprint",": the SHA-256 of the rendered file (the first page for a multi-page still render). Someone holding the file can compare it, for example with ",[23,682,683],{},"shasum -a 256 certificate.pdf",". When a reused document is rendered again, the fingerprint follows the latest file;",[521,686,687,690,691,102],{},[18,688,689],{},"Report this document",", see ",[98,692,693],{"href":493},"Reports and suspension",[14,695,696],{},"An unknown, mistyped or deleted id shows \"not found\". A page changes within about 30 seconds of a revoke.",[14,698,699,701],{},[23,700,352],{}," is a made-up certificate that explains the page. Sample QR codes point there.",[104,703,705],{"id":704},"manage-documents","Manage documents",[14,707,708,709,711],{},"Every document your space issued is on the ",[18,710,5],{}," page in your space's sidebar. Search by a public field or the document's id, see its status and any reports, and:",[518,713,714,720,726],{},[521,715,716,719],{},[18,717,718],{},"Revoke"," a document. Its page stays up with the status Revoked and the reason you give (up to 200 characters). The reason is public, so keep it factual: \"Issued in error\", \"Membership cancelled\".",[521,721,722,725],{},[18,723,724],{},"Delete"," a document. Its page then shows \"not found\", exactly like an id that never existed. Use it when the holder asks for their data to be removed.",[521,727,728,731],{},[18,729,730],{},"Export CSV"," of the list as filtered.",[14,733,734],{},"A space that still has valid documents cannot be deleted, because every printed QR code would then point at \"not found\". Revoke or delete them first.",[104,736,738],{"id":737},"verified-issuer","Verified issuer",[14,740,741,742,745],{},"Anyone can name a space \"Acme University\". To show people that a document really comes from ",[23,743,744],{},"acme.edu",", prove you control the domain:",[747,748,749,755],"ol",{},[521,750,751,752,754],{},"On the ",[18,753,5],{}," page, add your domain. bannx shows a DNS record for it.",[521,756,757],{},"Add a TXT record at your DNS provider:",[246,759,762],{"className":760,"code":761,"language":251},[249],"_bannx-verify.acme.edu   TXT   bannx-verify=\u003Ctoken>\n",[23,763,761],{"__ignoreMap":254},[747,765,767],{"start":766},3,[521,768,769,770,773,774,102],{},"Click ",[18,771,772],{},"Verify",". Once the record is found, every verify page of your space shows ",[18,775,776],{},"Verified issuer: acme.edu",[14,778,779],{},"DNS changes can take a while to appear. bannx re-checks verified domains about once a week; if the record is gone, the badge comes off. A domain verified by one space cannot be verified by another.",[104,781,693],{"id":782},"reports-and-suspension",[14,784,785],{},"Anyone on a verify page can report a document: it looks fake, it belongs to someone else, or the issuer is impersonating an organisation. A report can carry a message and an email for a reply. Nothing in a report is shown on the page.",[14,787,788,789,791,792,796],{},"You see the report count on your documents. Reports also reach bannx. If a space issues fake documents or impersonates an organisation, bannx can suspend its documents: every verify page of the space then says ",[18,790,650],{}," and withholds its fields, and the space cannot issue new documents. To appeal, write to ",[98,793,795],{"href":794},"mailto:contact@bannx.com","contact@bannx.com"," from the space owner's account.",[104,798,179],{"id":799},"privacy",[14,801,802],{},"What becomes public is what you choose:",[518,804,805,811,817,823,829],{},[521,806,807,810],{},[18,808,809],{},"Public fields only."," The verify page and the API return the public fields you picked, frozen at the moment the document was issued, plus the title, dates, photo and issuer. No other variable, nothing from the design and nothing about your space beyond its name, logo and verified domain is ever shown.",[521,812,813,816],{},[18,814,815],{},"Subject keys are not stored."," bannx keeps a one-way hash of the subject key, enough to recognise the same holder again. The email or member number itself is not kept and never shown, unless you also chose it as a public field.",[521,818,819,822],{},[18,820,821],{},"Photos come from your space."," The photo is shown only when its URL is a file in your space's media library (an upload or a generated image). A link to another site is left off the page.",[521,824,825,828],{},[18,826,827],{},"Ids are not guessable."," A document id is 128 random bits. Ids are not numbered, and an unknown id gets the same \"not found\" as a deleted one.",[521,830,831,834],{},[18,832,833],{},"Deleting removes it."," A deleted document is gone from its page and from the API.",[14,836,837],{},"Pick public fields that let someone check the document without exposing more than they need: a name and a course, not a date of birth and a home address.",[104,839,841],{"id":840},"api","API",[230,843,845],{"id":844},"the-render-response","The render response",[14,847,848],{},"When the template has verified documents on, a render's JSON carries the document it issued:",[246,850,854],{"className":851,"code":852,"language":853,"meta":254,"style":254},"language-json shiki shiki-themes bannx-docs-light bannx-docs-dark","{\n  \"ok\": true,\n  \"templateId\": \"TEMPLATE_ID\",\n  \"format\": \"pdf\",\n  \"url\": \"https:\u002F\u002F…\u002Frender.pdf\",\n  \"credential\": {\n    \"id\": \"4kT9xw2pQm7LbR1sVd8eZc\",\n    \"url\": \"https:\u002F\u002Fbannx.com\u002Fverify\u002F4kT9xw2pQm7LbR1sVd8eZc\",\n    \"code\": \"4KT9XW2P\",\n    \"reused\": false\n  }\n}\n","json",[23,855,856,865,888,910,931,952,966,988,1008,1027,1042,1048],{"__ignoreMap":254},[857,858,861],"span",{"class":859,"line":860},"line",1,[857,862,864],{"class":863},"sS_0z","{\n",[857,866,868,872,876,879,881,885],{"class":859,"line":867},2,[857,869,871],{"class":870},"selWe","  \"",[857,873,875],{"class":874},"sNgYv","ok",[857,877,878],{"class":870},"\"",[857,880,114],{"class":863},[857,882,884],{"class":883},"sMrpa"," true",[857,886,887],{"class":863},",\n",[857,889,890,892,895,897,899,902,906,908],{"class":859,"line":766},[857,891,871],{"class":870},[857,893,894],{"class":874},"templateId",[857,896,878],{"class":870},[857,898,114],{"class":863},[857,900,901],{"class":863}," \"",[857,903,905],{"class":904},"sYgty","TEMPLATE_ID",[857,907,878],{"class":863},[857,909,887],{"class":863},[857,911,913,915,918,920,922,924,927,929],{"class":859,"line":912},4,[857,914,871],{"class":870},[857,916,917],{"class":874},"format",[857,919,878],{"class":870},[857,921,114],{"class":863},[857,923,901],{"class":863},[857,925,926],{"class":904},"pdf",[857,928,878],{"class":863},[857,930,887],{"class":863},[857,932,934,936,939,941,943,945,948,950],{"class":859,"line":933},5,[857,935,871],{"class":870},[857,937,938],{"class":874},"url",[857,940,878],{"class":870},[857,942,114],{"class":863},[857,944,901],{"class":863},[857,946,947],{"class":904},"https:\u002F\u002F…\u002Frender.pdf",[857,949,878],{"class":863},[857,951,887],{"class":863},[857,953,955,957,959,961,963],{"class":859,"line":954},6,[857,956,871],{"class":870},[857,958,328],{"class":874},[857,960,878],{"class":870},[857,962,114],{"class":863},[857,964,965],{"class":863}," {\n",[857,967,969,972,975,977,979,981,984,986],{"class":859,"line":968},7,[857,970,971],{"class":870},"    \"",[857,973,974],{"class":874},"id",[857,976,878],{"class":870},[857,978,114],{"class":863},[857,980,901],{"class":863},[857,982,983],{"class":904},"4kT9xw2pQm7LbR1sVd8eZc",[857,985,878],{"class":863},[857,987,887],{"class":863},[857,989,991,993,995,997,999,1001,1004,1006],{"class":859,"line":990},8,[857,992,971],{"class":870},[857,994,938],{"class":874},[857,996,878],{"class":870},[857,998,114],{"class":863},[857,1000,901],{"class":863},[857,1002,1003],{"class":904},"https:\u002F\u002Fbannx.com\u002Fverify\u002F4kT9xw2pQm7LbR1sVd8eZc",[857,1005,878],{"class":863},[857,1007,887],{"class":863},[857,1009,1011,1013,1015,1017,1019,1021,1023,1025],{"class":859,"line":1010},9,[857,1012,971],{"class":870},[857,1014,23],{"class":874},[857,1016,878],{"class":870},[857,1018,114],{"class":863},[857,1020,901],{"class":863},[857,1022,300],{"class":904},[857,1024,878],{"class":863},[857,1026,887],{"class":863},[857,1028,1030,1032,1035,1037,1039],{"class":859,"line":1029},10,[857,1031,971],{"class":870},[857,1033,1034],{"class":874},"reused",[857,1036,878],{"class":870},[857,1038,114],{"class":863},[857,1040,1041],{"class":883}," false\n",[857,1043,1045],{"class":859,"line":1044},11,[857,1046,1047],{"class":863},"  }\n",[857,1049,1051],{"class":859,"line":1050},12,[857,1052,1053],{"class":863},"}\n",[14,1055,1056,349,1058,1061,1062,1068,1069,1072,1073,1075,1076,459,1079,1082,1083,1085,1086,1088],{},[23,1057,1034],{},[23,1059,1060],{},"true"," when an unchanged document of the same holder was rendered again. A ",[98,1063,1065],{"href":1064},"\u002Fdocs\u002Frendering#render-every-page-carousels",[23,1066,1067],{},"pages: \"all\""," render issues one document for the whole set. Raw responses (",[23,1070,1071],{},"raw: true",", or the default binary ",[23,1074,400],{}," render) have no JSON body, so the document rides as headers: ",[23,1077,1078],{},"x-credential-id",[23,1080,1081],{},"x-credential-url",". MCP ",[23,1084,411],{}," returns the same ",[23,1087,328],{}," object.",[14,1090,1091,1092,1095],{},"Store ",[23,1093,1094],{},"credential.id"," beside your own record of the person if you will want to find the document later.",[230,1097,560],{"id":1098},"bulk",[14,1100,1101,1102,1105,1106,1108],{},"A ",[98,1103,1104],{"href":426},"bulk run"," issues one document per rendered row. Give each row its holder with the reserved ",[23,1107,555],{}," key (a CSV column or a JSON key). It never reaches the template as a variable, and it overrides the template's subject key variable:",[246,1110,1114],{"className":1111,"code":1112,"language":1113,"meta":254,"style":254},"language-bash shiki shiki-themes bannx-docs-light bannx-docs-dark","curl -X POST https:\u002F\u002Fbannx.com\u002Fapi\u002Fv1\u002Ftemplates\u002FTEMPLATE_ID\u002Fbulk \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"format\": \"pdf\",\n    \"rows\": [\n      { \"id\": \"ada\",  \"recipient\": \"Ada Lovelace\", \"course\": \"Data Foundations\", \"_credentialKey\": \"ada@example.com\" },\n      { \"id\": \"alan\", \"recipient\": \"Alan Turing\",  \"course\": \"Data Foundations\", \"_credentialKey\": \"alan@example.com\" }\n    ]\n  }'\n","bash",[23,1115,1116,1133,1157,1167,1172,1177,1182,1187,1192],{"__ignoreMap":254},[857,1117,1118,1121,1124,1127,1130],{"class":859,"line":860},[857,1119,1120],{"class":883},"curl",[857,1122,1123],{"class":904}," -X",[857,1125,1126],{"class":904}," POST",[857,1128,1129],{"class":904}," https:\u002F\u002Fbannx.com\u002Fapi\u002Fv1\u002Ftemplates\u002FTEMPLATE_ID\u002Fbulk",[857,1131,1132],{"class":883}," \\\n",[857,1134,1135,1138,1140,1143,1145,1148,1150,1153,1155],{"class":859,"line":867},[857,1136,1137],{"class":904},"  -H",[857,1139,901],{"class":863},[857,1141,1142],{"class":904},"Authorization: Bearer YOUR_API_KEY",[857,1144,878],{"class":863},[857,1146,1147],{"class":904}," -H",[857,1149,901],{"class":863},[857,1151,1152],{"class":904},"Content-Type: application\u002Fjson",[857,1154,878],{"class":863},[857,1156,1132],{"class":883},[857,1158,1159,1162,1165],{"class":859,"line":766},[857,1160,1161],{"class":904},"  -d",[857,1163,1164],{"class":863}," '",[857,1166,864],{"class":904},[857,1168,1169],{"class":859,"line":912},[857,1170,1171],{"class":904},"    \"format\": \"pdf\",\n",[857,1173,1174],{"class":859,"line":933},[857,1175,1176],{"class":904},"    \"rows\": [\n",[857,1178,1179],{"class":859,"line":954},[857,1180,1181],{"class":904},"      { \"id\": \"ada\",  \"recipient\": \"Ada Lovelace\", \"course\": \"Data Foundations\", \"_credentialKey\": \"ada@example.com\" },\n",[857,1183,1184],{"class":859,"line":968},[857,1185,1186],{"class":904},"      { \"id\": \"alan\", \"recipient\": \"Alan Turing\",  \"course\": \"Data Foundations\", \"_credentialKey\": \"alan@example.com\" }\n",[857,1188,1189],{"class":859,"line":990},[857,1190,1191],{"class":904},"    ]\n",[857,1193,1194,1197],{"class":859,"line":1010},[857,1195,1196],{"class":904},"  }",[857,1198,1199],{"class":863},"'\n",[14,1201,1202,1203,1205,1206,1209,1210,1213,1214,1216],{},"Without ",[23,1204,555],{},", a row's holder comes from the subject key variable, as for a single render. The finished job lists the documents under ",[23,1207,1208],{},"credentials",", one entry per rendered row. ",[23,1211,1212],{},"row"," is the row's ",[23,1215,974],{}," key, else its position counted from 1:",[246,1218,1220],{"className":851,"code":1219,"language":853,"meta":254,"style":254},"{\n  \"jobId\": \"…\",\n  \"state\": \"completed\",\n  \"zipUrl\": \"https:\u002F\u002F…\u002Frenders.zip\",\n  \"credentials\": [\n    { \"row\": \"ada\",  \"credentialId\": \"4kT9xw2pQm7LbR1sVd8eZc\", \"url\": \"https:\u002F\u002Fbannx.com\u002Fverify\u002F4kT9xw2pQm7LbR1sVd8eZc\", \"code\": \"4KT9XW2P\", \"reused\": false },\n    { \"row\": \"alan\", \"credentialId\": \"9fQ2mR7tLx1KcW4pZb6nYa\", \"url\": \"https:\u002F\u002Fbannx.com\u002Fverify\u002F9fQ2mR7tLx1KcW4pZb6nYa\", \"code\": \"9FQ2MR7T\", \"reused\": false }\n  ]\n}\n",[23,1221,1222,1226,1246,1266,1286,1299,1385,1470,1475],{"__ignoreMap":254},[857,1223,1224],{"class":859,"line":860},[857,1225,864],{"class":863},[857,1227,1228,1230,1233,1235,1237,1239,1242,1244],{"class":859,"line":867},[857,1229,871],{"class":870},[857,1231,1232],{"class":874},"jobId",[857,1234,878],{"class":870},[857,1236,114],{"class":863},[857,1238,901],{"class":863},[857,1240,1241],{"class":904},"…",[857,1243,878],{"class":863},[857,1245,887],{"class":863},[857,1247,1248,1250,1253,1255,1257,1259,1262,1264],{"class":859,"line":766},[857,1249,871],{"class":870},[857,1251,1252],{"class":874},"state",[857,1254,878],{"class":870},[857,1256,114],{"class":863},[857,1258,901],{"class":863},[857,1260,1261],{"class":904},"completed",[857,1263,878],{"class":863},[857,1265,887],{"class":863},[857,1267,1268,1270,1273,1275,1277,1279,1282,1284],{"class":859,"line":912},[857,1269,871],{"class":870},[857,1271,1272],{"class":874},"zipUrl",[857,1274,878],{"class":870},[857,1276,114],{"class":863},[857,1278,901],{"class":863},[857,1280,1281],{"class":904},"https:\u002F\u002F…\u002Frenders.zip",[857,1283,878],{"class":863},[857,1285,887],{"class":863},[857,1287,1288,1290,1292,1294,1296],{"class":859,"line":933},[857,1289,871],{"class":870},[857,1291,1208],{"class":874},[857,1293,878],{"class":870},[857,1295,114],{"class":863},[857,1297,1298],{"class":863}," [\n",[857,1300,1301,1304,1306,1308,1310,1312,1314,1317,1319,1322,1324,1327,1329,1331,1333,1335,1337,1339,1341,1343,1345,1347,1349,1351,1353,1355,1357,1359,1361,1363,1365,1367,1369,1371,1373,1375,1377,1379,1382],{"class":859,"line":954},[857,1302,1303],{"class":863},"    {",[857,1305,901],{"class":870},[857,1307,1212],{"class":874},[857,1309,878],{"class":870},[857,1311,114],{"class":863},[857,1313,901],{"class":863},[857,1315,1316],{"class":904},"ada",[857,1318,878],{"class":863},[857,1320,1321],{"class":863},",",[857,1323,871],{"class":870},[857,1325,1326],{"class":874},"credentialId",[857,1328,878],{"class":870},[857,1330,114],{"class":863},[857,1332,901],{"class":863},[857,1334,983],{"class":904},[857,1336,878],{"class":863},[857,1338,1321],{"class":863},[857,1340,901],{"class":870},[857,1342,938],{"class":874},[857,1344,878],{"class":870},[857,1346,114],{"class":863},[857,1348,901],{"class":863},[857,1350,1003],{"class":904},[857,1352,878],{"class":863},[857,1354,1321],{"class":863},[857,1356,901],{"class":870},[857,1358,23],{"class":874},[857,1360,878],{"class":870},[857,1362,114],{"class":863},[857,1364,901],{"class":863},[857,1366,300],{"class":904},[857,1368,878],{"class":863},[857,1370,1321],{"class":863},[857,1372,901],{"class":870},[857,1374,1034],{"class":874},[857,1376,878],{"class":870},[857,1378,114],{"class":863},[857,1380,1381],{"class":883}," false",[857,1383,1384],{"class":863}," },\n",[857,1386,1387,1389,1391,1393,1395,1397,1399,1402,1404,1406,1408,1410,1412,1414,1416,1419,1421,1423,1425,1427,1429,1431,1433,1436,1438,1440,1442,1444,1446,1448,1450,1453,1455,1457,1459,1461,1463,1465,1467],{"class":859,"line":968},[857,1388,1303],{"class":863},[857,1390,901],{"class":870},[857,1392,1212],{"class":874},[857,1394,878],{"class":870},[857,1396,114],{"class":863},[857,1398,901],{"class":863},[857,1400,1401],{"class":904},"alan",[857,1403,878],{"class":863},[857,1405,1321],{"class":863},[857,1407,901],{"class":870},[857,1409,1326],{"class":874},[857,1411,878],{"class":870},[857,1413,114],{"class":863},[857,1415,901],{"class":863},[857,1417,1418],{"class":904},"9fQ2mR7tLx1KcW4pZb6nYa",[857,1420,878],{"class":863},[857,1422,1321],{"class":863},[857,1424,901],{"class":870},[857,1426,938],{"class":874},[857,1428,878],{"class":870},[857,1430,114],{"class":863},[857,1432,901],{"class":863},[857,1434,1435],{"class":904},"https:\u002F\u002Fbannx.com\u002Fverify\u002F9fQ2mR7tLx1KcW4pZb6nYa",[857,1437,878],{"class":863},[857,1439,1321],{"class":863},[857,1441,901],{"class":870},[857,1443,23],{"class":874},[857,1445,878],{"class":870},[857,1447,114],{"class":863},[857,1449,901],{"class":863},[857,1451,1452],{"class":904},"9FQ2MR7T",[857,1454,878],{"class":863},[857,1456,1321],{"class":863},[857,1458,901],{"class":870},[857,1460,1034],{"class":874},[857,1462,878],{"class":870},[857,1464,114],{"class":863},[857,1466,1381],{"class":883},[857,1468,1469],{"class":863}," }\n",[857,1471,1472],{"class":859,"line":990},[857,1473,1474],{"class":863},"  ]\n",[857,1476,1477],{"class":859,"line":1010},[857,1478,1053],{"class":863},[14,1480,1481,1482,1485],{},"Documents of a bulk run become valid when the ZIP or PDF is delivered. A row that failed is in ",[23,1483,1484],{},"errors"," and has no document.",[230,1487,1489],{"id":1488},"check-a-document-from-code","Check a document from code",[14,1491,1492,1495],{},[23,1493,1494],{},"GET \u002Fapi\u002Fv1\u002Fcredentials\u002F:id"," is the verify page as JSON. No authentication: the id is the key.",[246,1497,1499],{"className":1111,"code":1498,"language":1113,"meta":254,"style":254},"curl https:\u002F\u002Fbannx.com\u002Fapi\u002Fv1\u002Fcredentials\u002F4kT9xw2pQm7LbR1sVd8eZc\n",[23,1500,1501],{"__ignoreMap":254},[857,1502,1503,1505],{"class":859,"line":860},[857,1504,1120],{"class":883},[857,1506,1507],{"class":904}," https:\u002F\u002Fbannx.com\u002Fapi\u002Fv1\u002Fcredentials\u002F4kT9xw2pQm7LbR1sVd8eZc\n",[246,1509,1511],{"className":851,"code":1510,"language":853,"meta":254,"style":254},"{\n  \"status\": \"valid\",\n  \"kind\": \"certificate\",\n  \"title\": \"Certificate of completion\",\n  \"fields\": [\n    { \"label\": \"Name\", \"value\": \"Ada Lovelace\" },\n    { \"label\": \"Course\", \"value\": \"Data Foundations\" }\n  ],\n  \"photoUrl\": null,\n  \"issuedAt\": \"2026-11-20T09:12:44.000Z\",\n  \"expiresAt\": null,\n  \"revokedAt\": null,\n  \"revokedReason\": null,\n  \"replacedBy\": null,\n  \"fileSha256\": \"9b74c9897bac770ffc029102a200c5de…\",\n  \"previewUrl\": null,\n  \"issuer\": { \"name\": \"Northfield Learning Centre\", \"logoUrl\": \"https:\u002F\u002F…\u002Flogo.png\", \"verifiedDomain\": \"northfield.edu\" }\n}\n",[23,1512,1513,1517,1536,1556,1576,1589,1629,1667,1672,1688,1708,1723,1738,1754,1770,1791,1807,1876],{"__ignoreMap":254},[857,1514,1515],{"class":859,"line":860},[857,1516,864],{"class":863},[857,1518,1519,1521,1524,1526,1528,1530,1532,1534],{"class":859,"line":867},[857,1520,871],{"class":870},[857,1522,1523],{"class":874},"status",[857,1525,878],{"class":870},[857,1527,114],{"class":863},[857,1529,901],{"class":863},[857,1531,596],{"class":904},[857,1533,878],{"class":863},[857,1535,887],{"class":863},[857,1537,1538,1540,1543,1545,1547,1549,1552,1554],{"class":859,"line":766},[857,1539,871],{"class":870},[857,1541,1542],{"class":874},"kind",[857,1544,878],{"class":870},[857,1546,114],{"class":863},[857,1548,901],{"class":863},[857,1550,1551],{"class":904},"certificate",[857,1553,878],{"class":863},[857,1555,887],{"class":863},[857,1557,1558,1560,1563,1565,1567,1569,1572,1574],{"class":859,"line":912},[857,1559,871],{"class":870},[857,1561,1562],{"class":874},"title",[857,1564,878],{"class":870},[857,1566,114],{"class":863},[857,1568,901],{"class":863},[857,1570,1571],{"class":904},"Certificate of completion",[857,1573,878],{"class":863},[857,1575,887],{"class":863},[857,1577,1578,1580,1583,1585,1587],{"class":859,"line":933},[857,1579,871],{"class":870},[857,1581,1582],{"class":874},"fields",[857,1584,878],{"class":870},[857,1586,114],{"class":863},[857,1588,1298],{"class":863},[857,1590,1591,1593,1595,1598,1600,1602,1604,1607,1609,1611,1613,1616,1618,1620,1622,1625,1627],{"class":859,"line":954},[857,1592,1303],{"class":863},[857,1594,901],{"class":870},[857,1596,1597],{"class":874},"label",[857,1599,878],{"class":870},[857,1601,114],{"class":863},[857,1603,901],{"class":863},[857,1605,1606],{"class":904},"Name",[857,1608,878],{"class":863},[857,1610,1321],{"class":863},[857,1612,901],{"class":870},[857,1614,1615],{"class":874},"value",[857,1617,878],{"class":870},[857,1619,114],{"class":863},[857,1621,901],{"class":863},[857,1623,1624],{"class":904},"Ada Lovelace",[857,1626,878],{"class":863},[857,1628,1384],{"class":863},[857,1630,1631,1633,1635,1637,1639,1641,1643,1646,1648,1650,1652,1654,1656,1658,1660,1663,1665],{"class":859,"line":968},[857,1632,1303],{"class":863},[857,1634,901],{"class":870},[857,1636,1597],{"class":874},[857,1638,878],{"class":870},[857,1640,114],{"class":863},[857,1642,901],{"class":863},[857,1644,1645],{"class":904},"Course",[857,1647,878],{"class":863},[857,1649,1321],{"class":863},[857,1651,901],{"class":870},[857,1653,1615],{"class":874},[857,1655,878],{"class":870},[857,1657,114],{"class":863},[857,1659,901],{"class":863},[857,1661,1662],{"class":904},"Data Foundations",[857,1664,878],{"class":863},[857,1666,1469],{"class":863},[857,1668,1669],{"class":859,"line":990},[857,1670,1671],{"class":863},"  ],\n",[857,1673,1674,1676,1679,1681,1683,1686],{"class":859,"line":1010},[857,1675,871],{"class":870},[857,1677,1678],{"class":874},"photoUrl",[857,1680,878],{"class":870},[857,1682,114],{"class":863},[857,1684,1685],{"class":883}," null",[857,1687,887],{"class":863},[857,1689,1690,1692,1695,1697,1699,1701,1704,1706],{"class":859,"line":1029},[857,1691,871],{"class":870},[857,1693,1694],{"class":874},"issuedAt",[857,1696,878],{"class":870},[857,1698,114],{"class":863},[857,1700,901],{"class":863},[857,1702,1703],{"class":904},"2026-11-20T09:12:44.000Z",[857,1705,878],{"class":863},[857,1707,887],{"class":863},[857,1709,1710,1712,1715,1717,1719,1721],{"class":859,"line":1044},[857,1711,871],{"class":870},[857,1713,1714],{"class":874},"expiresAt",[857,1716,878],{"class":870},[857,1718,114],{"class":863},[857,1720,1685],{"class":883},[857,1722,887],{"class":863},[857,1724,1725,1727,1730,1732,1734,1736],{"class":859,"line":1050},[857,1726,871],{"class":870},[857,1728,1729],{"class":874},"revokedAt",[857,1731,878],{"class":870},[857,1733,114],{"class":863},[857,1735,1685],{"class":883},[857,1737,887],{"class":863},[857,1739,1741,1743,1746,1748,1750,1752],{"class":859,"line":1740},13,[857,1742,871],{"class":870},[857,1744,1745],{"class":874},"revokedReason",[857,1747,878],{"class":870},[857,1749,114],{"class":863},[857,1751,1685],{"class":883},[857,1753,887],{"class":863},[857,1755,1757,1759,1762,1764,1766,1768],{"class":859,"line":1756},14,[857,1758,871],{"class":870},[857,1760,1761],{"class":874},"replacedBy",[857,1763,878],{"class":870},[857,1765,114],{"class":863},[857,1767,1685],{"class":883},[857,1769,887],{"class":863},[857,1771,1773,1775,1778,1780,1782,1784,1787,1789],{"class":859,"line":1772},15,[857,1774,871],{"class":870},[857,1776,1777],{"class":874},"fileSha256",[857,1779,878],{"class":870},[857,1781,114],{"class":863},[857,1783,901],{"class":863},[857,1785,1786],{"class":904},"9b74c9897bac770ffc029102a200c5de…",[857,1788,878],{"class":863},[857,1790,887],{"class":863},[857,1792,1794,1796,1799,1801,1803,1805],{"class":859,"line":1793},16,[857,1795,871],{"class":870},[857,1797,1798],{"class":874},"previewUrl",[857,1800,878],{"class":870},[857,1802,114],{"class":863},[857,1804,1685],{"class":883},[857,1806,887],{"class":863},[857,1808,1810,1812,1815,1817,1819,1822,1824,1827,1829,1831,1833,1836,1838,1840,1842,1845,1847,1849,1851,1854,1856,1858,1860,1863,1865,1867,1869,1872,1874],{"class":859,"line":1809},17,[857,1811,871],{"class":870},[857,1813,1814],{"class":874},"issuer",[857,1816,878],{"class":870},[857,1818,114],{"class":863},[857,1820,1821],{"class":863}," {",[857,1823,901],{"class":870},[857,1825,1826],{"class":874},"name",[857,1828,878],{"class":870},[857,1830,114],{"class":863},[857,1832,901],{"class":863},[857,1834,1835],{"class":904},"Northfield Learning Centre",[857,1837,878],{"class":863},[857,1839,1321],{"class":863},[857,1841,901],{"class":870},[857,1843,1844],{"class":874},"logoUrl",[857,1846,878],{"class":870},[857,1848,114],{"class":863},[857,1850,901],{"class":863},[857,1852,1853],{"class":904},"https:\u002F\u002F…\u002Flogo.png",[857,1855,878],{"class":863},[857,1857,1321],{"class":863},[857,1859,901],{"class":870},[857,1861,1862],{"class":874},"verifiedDomain",[857,1864,878],{"class":870},[857,1866,114],{"class":863},[857,1868,901],{"class":863},[857,1870,1871],{"class":904},"northfield.edu",[857,1873,878],{"class":863},[857,1875,1469],{"class":863},[857,1877,1879],{"class":859,"line":1878},18,[857,1880,1053],{"class":863},[34,1882,1883,1893],{},[37,1884,1885],{},[40,1886,1887,1890],{},[43,1888,1889],{},"Field",[43,1891,1892],{},"Notes",[53,1894,1895,1915,1931,1944,1959,1972,1981,1990],{},[40,1896,1897,1901],{},[58,1898,1899],{},[23,1900,1523],{},[58,1902,1903,1905,1906,1905,1908,1905,1910,217,1912,1914],{},[23,1904,596],{},", ",[23,1907,609],{},[23,1909,622],{},[23,1911,635],{},[23,1913,494],{},", worked out when you ask.",[40,1916,1917,1921],{},[58,1918,1919],{},[23,1920,1542],{},[58,1922,1923,1905,1925,217,1928,102],{},[23,1924,1551],{},[23,1926,1927],{},"idcard",[23,1929,1930],{},"badge",[40,1932,1933,1937],{},[58,1934,1935],{},[23,1936,1582],{},[58,1938,1939,1940,1943],{},"The public fields as ",[23,1941,1942],{},"{ label, value }",", in your order. Empty while the issuer is suspended.",[40,1945,1946,1952],{},[58,1947,1948,1905,1950],{},[23,1949,1729],{},[23,1951,1745],{},[58,1953,1954,1955,349,1957,102],{},"Set when ",[23,1956,1523],{},[23,1958,622],{},[40,1960,1961,1965],{},[58,1962,1963],{},[23,1964,1761],{},[58,1966,1967,1968,349,1970,102],{},"The id of the newer document, when ",[23,1969,1523],{},[23,1971,635],{},[40,1973,1974,1978],{},[58,1975,1976],{},[23,1977,1777],{},[58,1979,1980],{},"SHA-256 (hex) of the rendered file.",[40,1982,1983,1987],{},[58,1984,1985],{},[23,1986,1798],{},[58,1988,1989],{},"The rendered image, for PNG and WebP documents.",[40,1991,1992,1997],{},[58,1993,1994],{},[23,1995,1996],{},"issuer.verifiedDomain",[58,1998,1999,2000,2003,2004,2007],{},"Set only while the issuer has a ",[98,2001,2002],{"href":668},"verified domain","; ",[23,2005,2006],{},"null"," means bannx has not confirmed who the issuer is.",[14,2009,2010,2011,499,2014,2017,2018,499,2021,2024],{},"An unknown or deleted id is ",[23,2012,2013],{},"404",[23,2015,2016],{},"CREDENTIAL_NOT_FOUND",". Lookups are limited to 60 a minute per IP address (",[23,2019,2020],{},"429",[23,2022,2023],{},"RATE_LIMITED","), and an answer may be cached for 30 seconds.",[14,2026,2027,2030,2031,2034],{},[23,2028,2029],{},"POST \u002Fapi\u002Fv1\u002Fcredentials\u002F:id\u002Freport"," files a report, also without authentication: ",[23,2032,2033],{},"{ \"reason\": \"fake\" | \"wrong_person\" | \"impersonation\" | \"other\", \"message\"?, \"email\"? }"," (message up to 1000 characters). At most 5 reports an hour per address, and one per document per day.",[14,2036,2037,2038,102],{},"Both routes are in the ",[98,2039,2041],{"href":2040},"\u002Fdocs\u002Fapi","API reference",[230,2043,2045],{"id":2044},"from-an-agent-mcp","From an agent (MCP)",[14,2047,2048,2049,459,2052,114],{},"An agent turns the setting on with ",[23,2050,2051],{},"template_apply_ops",[23,2053,2054],{},"settings",[246,2056,2058],{"className":851,"code":2057,"language":853,"meta":254,"style":254},"{\n  \"templateId\": \"TEMPLATE_ID\",\n  \"settings\": {\n    \"credentials\": {\n      \"enabled\": true,\n      \"kind\": \"certificate\",\n      \"title\": \"Certificate of completion\",\n      \"publicFields\": [\n        { \"variable\": \"recipient\", \"label\": \"Name\" },\n        { \"variable\": \"course\", \"label\": \"Course\" }\n      ],\n      \"subjectKeyVariable\": \"email\",\n      \"expiresInDays\": 365\n    }\n  }\n}\n",[23,2059,2060,2064,2082,2094,2106,2122,2140,2158,2171,2209,2245,2250,2269,2283,2288,2292],{"__ignoreMap":254},[857,2061,2062],{"class":859,"line":860},[857,2063,864],{"class":863},[857,2065,2066,2068,2070,2072,2074,2076,2078,2080],{"class":859,"line":867},[857,2067,871],{"class":870},[857,2069,894],{"class":874},[857,2071,878],{"class":870},[857,2073,114],{"class":863},[857,2075,901],{"class":863},[857,2077,905],{"class":904},[857,2079,878],{"class":863},[857,2081,887],{"class":863},[857,2083,2084,2086,2088,2090,2092],{"class":859,"line":766},[857,2085,871],{"class":870},[857,2087,2054],{"class":874},[857,2089,878],{"class":870},[857,2091,114],{"class":863},[857,2093,965],{"class":863},[857,2095,2096,2098,2100,2102,2104],{"class":859,"line":912},[857,2097,971],{"class":870},[857,2099,1208],{"class":874},[857,2101,878],{"class":870},[857,2103,114],{"class":863},[857,2105,965],{"class":863},[857,2107,2108,2111,2114,2116,2118,2120],{"class":859,"line":933},[857,2109,2110],{"class":870},"      \"",[857,2112,2113],{"class":874},"enabled",[857,2115,878],{"class":870},[857,2117,114],{"class":863},[857,2119,884],{"class":883},[857,2121,887],{"class":863},[857,2123,2124,2126,2128,2130,2132,2134,2136,2138],{"class":859,"line":954},[857,2125,2110],{"class":870},[857,2127,1542],{"class":874},[857,2129,878],{"class":870},[857,2131,114],{"class":863},[857,2133,901],{"class":863},[857,2135,1551],{"class":904},[857,2137,878],{"class":863},[857,2139,887],{"class":863},[857,2141,2142,2144,2146,2148,2150,2152,2154,2156],{"class":859,"line":968},[857,2143,2110],{"class":870},[857,2145,1562],{"class":874},[857,2147,878],{"class":870},[857,2149,114],{"class":863},[857,2151,901],{"class":863},[857,2153,1571],{"class":904},[857,2155,878],{"class":863},[857,2157,887],{"class":863},[857,2159,2160,2162,2165,2167,2169],{"class":859,"line":990},[857,2161,2110],{"class":870},[857,2163,2164],{"class":874},"publicFields",[857,2166,878],{"class":870},[857,2168,114],{"class":863},[857,2170,1298],{"class":863},[857,2172,2173,2176,2178,2181,2183,2185,2187,2189,2191,2193,2195,2197,2199,2201,2203,2205,2207],{"class":859,"line":1010},[857,2174,2175],{"class":863},"        {",[857,2177,901],{"class":870},[857,2179,2180],{"class":874},"variable",[857,2182,878],{"class":870},[857,2184,114],{"class":863},[857,2186,901],{"class":863},[857,2188,170],{"class":904},[857,2190,878],{"class":863},[857,2192,1321],{"class":863},[857,2194,901],{"class":870},[857,2196,1597],{"class":874},[857,2198,878],{"class":870},[857,2200,114],{"class":863},[857,2202,901],{"class":863},[857,2204,1606],{"class":904},[857,2206,878],{"class":863},[857,2208,1384],{"class":863},[857,2210,2211,2213,2215,2217,2219,2221,2223,2225,2227,2229,2231,2233,2235,2237,2239,2241,2243],{"class":859,"line":1029},[857,2212,2175],{"class":863},[857,2214,901],{"class":870},[857,2216,2180],{"class":874},[857,2218,878],{"class":870},[857,2220,114],{"class":863},[857,2222,901],{"class":863},[857,2224,174],{"class":904},[857,2226,878],{"class":863},[857,2228,1321],{"class":863},[857,2230,901],{"class":870},[857,2232,1597],{"class":874},[857,2234,878],{"class":870},[857,2236,114],{"class":863},[857,2238,901],{"class":863},[857,2240,1645],{"class":904},[857,2242,878],{"class":863},[857,2244,1469],{"class":863},[857,2246,2247],{"class":859,"line":1044},[857,2248,2249],{"class":863},"      ],\n",[857,2251,2252,2254,2257,2259,2261,2263,2265,2267],{"class":859,"line":1050},[857,2253,2110],{"class":870},[857,2255,2256],{"class":874},"subjectKeyVariable",[857,2258,878],{"class":870},[857,2260,114],{"class":863},[857,2262,901],{"class":863},[857,2264,216],{"class":904},[857,2266,878],{"class":863},[857,2268,887],{"class":863},[857,2270,2271,2273,2276,2278,2280],{"class":859,"line":1740},[857,2272,2110],{"class":870},[857,2274,2275],{"class":874},"expiresInDays",[857,2277,878],{"class":870},[857,2279,114],{"class":863},[857,2281,2282],{"class":883}," 365\n",[857,2284,2285],{"class":859,"line":1756},[857,2286,2287],{"class":863},"    }\n",[857,2289,2290],{"class":859,"line":1772},[857,2291,1047],{"class":863},[857,2293,2294],{"class":859,"line":1793},[857,2295,1053],{"class":863},[14,2297,2298,2301,2302,2305,2306,2308,2309,2312,2313,2316,2317,2319,2320,102],{},[23,2299,2300],{},"photoVariable"," (ID cards and badges, an image variable) and ",[23,2303,2304],{},"expiresVariable"," (a date variable, instead of ",[23,2307,2275],{},") complete the setting; ",[23,2310,2311],{},"\"credentials\": null"," clears it. Bind a QR layer's ",[23,2314,2315],{},"payload"," to ",[23,2318,280],{},", publish the template, then call ",[23,2321,411],{},[104,2323,2324],{"id":1484},"Errors",[34,2326,2327,2339],{},[37,2328,2329],{},[40,2330,2331,2334,2336],{},[43,2332,2333],{},"Code",[43,2335,581],{},[43,2337,2338],{},"When",[53,2340,2341,2352,2363],{},[40,2342,2343,2347,2349],{},[58,2344,2345],{},[23,2346,502],{},[58,2348,498],{},[58,2350,2351],{},"The space's documents are suspended, so a template with verified documents on cannot render.",[40,2353,2354,2358,2360],{},[58,2355,2356],{},[23,2357,2016],{},[58,2359,2013],{},[58,2361,2362],{},"No document with that id, or it was deleted.",[40,2364,2365,2370,2373],{},[58,2366,2367],{},[23,2368,2369],{},"VALIDATION",[58,2371,2372],{},"422",[58,2374,2375,2376,2379],{},"The setting names a variable the template does not declare, or a render's expiry variable is not a date (",[23,2377,2378],{},"fieldErrors"," names the variable).",[14,2381,2382,2383,2386],{},"The full list is on the ",[98,2384,2324],{"href":2385},"\u002Fdocs\u002Ferrors"," page.",[104,2388,2390],{"id":2389},"related-docs","Related docs",[518,2392,2393,2400,2407,2414],{},[521,2394,2395,2399],{},[98,2396,2398],{"href":2397},"\u002Fdocs\u002Frendering","Rendering API",": the render request and response, bulk runs, credits.",[521,2401,2402,2406],{},[98,2403,2405],{"href":2404},"\u002Fdocs\u002Ftemplates","Templates",": QR code layers and publishing.",[521,2408,2409,2413],{},[98,2410,2412],{"href":2411},"\u002Fdocs\u002Fvariables","Variables",": declaring the variables the setting names.",[521,2415,2416,2418],{},[98,2417,2324],{"href":2385},": every error code.",[2420,2421,2422],"style",{},"html pre.shiki code .sS_0z, html code.shiki .sS_0z{--shiki-default:#A1A1AA;--shiki-dark:#71717A}html pre.shiki code .selWe, html code.shiki .selWe{--shiki-default:#A1A1AA;--shiki-default-font-weight:bold;--shiki-dark:#71717A;--shiki-dark-font-weight:bold}html pre.shiki code .sNgYv, html code.shiki .sNgYv{--shiki-default:#09090B;--shiki-default-font-weight:bold;--shiki-dark:#FFFFFF;--shiki-dark-font-weight:bold}html pre.shiki code .sMrpa, html code.shiki .sMrpa{--shiki-default:#18181B;--shiki-dark:#FAFAFA}html pre.shiki code .sYgty, html code.shiki .sYgty{--shiki-default:#52525B;--shiki-dark:#D4D4D8}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":254,"searchDepth":867,"depth":867,"links":2424},[2425,2429,2430,2431,2432,2433,2434,2435,2436,2442,2443],{"id":106,"depth":867,"text":107,"children":2426},[2427,2428],{"id":232,"depth":766,"text":233},{"id":356,"depth":766,"text":357},{"id":371,"depth":867,"text":372},{"id":506,"depth":867,"text":225},{"id":563,"depth":867,"text":564},{"id":704,"depth":867,"text":705},{"id":737,"depth":867,"text":738},{"id":782,"depth":867,"text":693},{"id":799,"depth":867,"text":179},{"id":840,"depth":867,"text":841,"children":2437},[2438,2439,2440,2441],{"id":844,"depth":766,"text":845},{"id":1098,"depth":766,"text":560},{"id":1488,"depth":766,"text":1489},{"id":2044,"depth":766,"text":2045},{"id":1484,"depth":867,"text":2324},{"id":2389,"depth":867,"text":2390},"Give every certificate, ID card or event badge you render its own public verify page. A QR code on the document opens it, and anyone can check that it is genuine, still valid and issued by you.","md",{"layout":2447,"updatedAt":2448},"docs","2026-11-20",true,"\u002Fdocs\u002Fverified-documents",{"title":5,"description":2444},"docs\u002Fverified-documents","GbY9GZWaAB2ONF1zJBbjYPgCz_5ZAkDTem5mg_piFl0",{"success":2449,"routes":2455,"total":3279,"generatedAt":3280,"canViewAllApiDocs":2481},[2456,2472,2495,2556,2563,2583,2596,2629,2653,2670,2685,2714,2732,2759,2778,2858,2930,3076,3124,3138,3184,3197,3225,3263],{"path":2457,"method":400,"summary":2458,"description":2459,"tags":2460,"parameters":2462,"responses":2466,"actionName":2471},"\u002Fapi\u002Fv1\u002Fbrands\u002F:id","Get a brand","Fetch one brand by ID. Public brands (publicOn set) need no auth; private brands require a dashboard session in the owning space. For API-key access use the MCP server (get_brand).",[2461],"Brands",[2463],{"in":2464,"name":974,"required":2449,"description":2465},"path","Brand ID",{"200":2467,"404":2469},{"description":2468},"JSON { doc } — the brand with its token sets",{"description":2470},"Not found or not accessible","getBrand",{"path":2473,"method":400,"summary":2474,"description":2475,"tags":2476,"parameters":2477,"responses":2489,"actionName":2494},"\u002Fapi\u002Fv1\u002Fbrands\u002Findex","List brands","List brands in the current space. Session-authenticated (dashboard login); pass ?public=true to list public brands anonymously. For API-key access use the MCP server (list_brands).",[2461],[2478,2483,2486],{"in":2479,"name":2480,"required":2481,"description":2482},"query","page",false,"Page number (default 1)",{"in":2479,"name":2484,"required":2481,"description":2485},"perPage","Items per page (default 50)",{"in":2479,"name":2487,"required":2481,"description":2488},"public","\"true\" to list public brands without auth",{"200":2490,"401":2492},{"description":2491},"JSON { list, count, pagesCount } of brands",{"description":2493},"Not logged in (when public is not set)","listBrands",{"path":2496,"method":400,"summary":2497,"description":2498,"tags":2499,"parameters":2500,"responses":2506,"actionName":2555},"\u002Fapi\u002Fv1\u002Fcredentials\u002F:publicId","Verify a document","Check a verified document (certificate, ID card, event badge) by the id in its QR code or verify link (`\u002Fverify\u002F{publicId}`). No authentication. Returns the document's status — `valid`, `expired` (past `expiresAt`), `revoked` (by the issuer, with the reason they gave), `replaced` (a newer document of the same holder, see `replacedBy`) or `suspended` (bannx suspended the issuer; fields are withheld) — with the public fields the issuer chose to show, frozen when it was issued, and who issued it. `issuer.verifiedDomain` is set only while the issuer has proved control of that domain over DNS. Unknown ids get the same 404 as deleted ones. Responses may be cached for 30 seconds.",[5],[2501],{"in":2464,"name":2502,"required":2449,"description":2503,"schema":2504},"publicId","The document's public id: 22 letters and digits, as printed in its verify link.",{"type":2505},"string",{"200":2507,"404":2551,"429":2553},{"description":2508,"content":2509},"The document's public view.",{"application\u002Fjson":2510},{"schema":2511},{"type":2512,"required":2513,"properties":2514},"object",[1523,1542,1562,1582,1678,1694,1714,1729,1745,1761,1777,1798,1814],{"status":2515,"kind":2518,"title":2521,"fields":2523,"photoUrl":2530,"issuedAt":2532,"expiresAt":2534,"revokedAt":2535,"revokedReason":2536,"replacedBy":2538,"fileSha256":2540,"previewUrl":2542,"issuer":2544},{"type":2505,"enum":2516,"description":2517},[596,609,622,635,494],"valid | expired | revoked | replaced | suspended (computed when read).",{"type":2505,"enum":2519,"description":2520},[1551,1927,1930],"certificate, idcard (ID \u002F membership \u002F staff \u002F student card) or badge (event badge).",{"type":2505,"nullable":2449,"description":2522},"The issuer's title for the document, e.g. \"Certificate of completion\".",{"type":2524,"description":2525,"items":2526},"array","The public fields, in the issuer's order (at most 12; empty while the issuer is suspended).",{"type":2512,"properties":2527},{"label":2528,"value":2529},{"type":2505},{"type":2505},{"type":2505,"nullable":2449,"description":2531},"The holder's photo (ID cards and badges), a file the issuer uploaded.",{"type":2505,"nullable":2449,"format":2533},"date-time",{"type":2505,"nullable":2449,"format":2533},{"type":2505,"nullable":2449,"format":2533},{"type":2505,"nullable":2449,"description":2537},"Shown on revoked documents.",{"type":2505,"nullable":2449,"description":2539},"The public id of the newer document, when status is replaced.",{"type":2505,"nullable":2449,"description":2541},"SHA-256 (hex) of the rendered file, to compare with a copy.",{"type":2505,"nullable":2449,"description":2543},"The rendered image, for PNG \u002F WebP documents.",{"type":2512,"properties":2545},{"name":2546,"logoUrl":2548,"verifiedDomain":2549},{"type":2505,"description":2547},"The issuing workspace's name, as the issuer set it.",{"type":2505,"nullable":2449},{"type":2505,"nullable":2449,"description":2550},"A domain the issuer proved over DNS; null = bannx has not confirmed who the issuer is.",{"description":2552},"No such document (CREDENTIAL_NOT_FOUND) — the same answer for unknown, mistyped and deleted ids.",{"description":2554},"Too many lookups from this address (RATE_LIMITED).","getPublicCredential",{"path":2557,"method":2558,"summary":2559,"description":2560,"tags":2561,"actionName":2562},"\u002Fapi\u002Fv1\u002Fcredentials\u002F:publicId\u002Freport","POST","Report a document","Flag a verified document as suspicious — it looks fake, it belongs to someone else, or the issuer is impersonating an organisation. No authentication. The issuer and bannx see the report; nothing in it is shown publicly. At most 5 reports an hour from one address, and one per document per day (a repeat is accepted and dropped).",[5],"reportPublicCredential",{"path":2564,"method":2565,"summary":2566,"description":2567,"tags":2568,"parameters":2570,"responses":2573,"actionName":2582},"\u002Fapi\u002Fv1\u002Fintegrations\u002Fhooks\u002F:id","DELETE","Unsubscribe from an event (integrations)","Removes a subscription made with `POST \u002Fapi\u002Fv1\u002Fintegrations\u002Fhooks`, the way Zapier unsubscribes when a Zap turns off. Only removes subscriptions an integration created, in the key's space. Bearer API key with the `webhook.manage` scope.",[2569],"Integrations",[2571],{"in":2464,"name":974,"required":2449,"description":2572},"Subscription id returned on subscribe.",{"200":2574,"401":2576,"403":2578,"404":2580},{"description":2575},"JSON { ok: true, id }",{"description":2577},"Missing or invalid API key, or the key lacks the webhook.manage scope (SCOPE_DENIED).",{"description":2579},"The key's user may not manage webhooks in the space (FORBIDDEN).",{"description":2581},"No integration subscription with that id in the key's space (HOOK_NOT_FOUND).","integrationsUnsubscribeHook",{"path":2564,"method":400,"summary":2584,"description":2585,"tags":2586,"parameters":2587,"responses":2589,"actionName":2595},"Get an event subscription (integrations)","Reads a subscription made with `POST \u002Fapi\u002Fv1\u002Fintegrations\u002Fhooks`, so an automation platform can check it still exists before reusing it. 404 means it was removed (in Settings → Developers, or by an unsubscribe) and should be created again. Never returns the signing secret. Bearer API key with the `webhook.manage` scope.",[2569],[2588],{"in":2464,"name":974,"required":2449,"description":2572},{"200":2590,"401":2592,"403":2593,"404":2594},{"description":2591},"JSON { id, event, targetUrl, enabled, templateId?, platform?, signed }",{"description":2577},{"description":2579},{"description":2581},"integrationsGetHook",{"path":2597,"method":2558,"summary":2598,"description":2599,"tags":2600,"requestBody":2601,"responses":2621,"actionName":2628},"\u002Fapi\u002Fv1\u002Fintegrations\u002Fhooks\u002Findex","Subscribe to an event (integrations)","Registers an automation platform's URL for an event, the way Zapier REST hooks subscribe when a Zap turns on. bannx then POSTs `{ id, event, timestamp, spaceId, data }` to `targetUrl` each time the event happens in the key's space; for `render.completed`, `data` holds `templateId`, `format` and `url`. Bearer API key with the `webhook.manage` scope, whose user may manage webhooks in the space. `targetUrl` must be a public HTTPS URL. `templateId` is stored with the subscription so the platform can filter; delivery is not filtered.",[2569],{"required":2449,"content":2602},{"application\u002Fjson":2603},{"schema":2604},{"type":2512,"required":2605,"properties":2608},[2606,2607],"targetUrl","event",{"targetUrl":2609,"event":2611,"templateId":2615,"platform":2617,"secret":2619},{"type":2505,"description":2610},"Public HTTPS URL that receives the events.",{"type":2505,"enum":2612,"description":2614},[2613],"render.completed","Event to subscribe to.",{"type":2505,"description":2616},"Optional template the subscriber cares about.",{"type":2505,"description":2618},"Who is subscribing, shown in Settings → Developers. Default \"integration\".",{"type":2505,"description":2620},"Optional, 16-200 characters. bannx then signs each delivery with `X-Webhook-Signature: sha256=\u003Chex HMAC-SHA256 of the raw body>` so the receiver can verify it came from bannx.",{"200":2622,"400":2624,"401":2626,"403":2627},{"description":2623},"JSON { id, event, targetUrl } — keep `id` to unsubscribe.",{"description":2625},"targetUrl is not a public HTTPS URL, or the space has too many integration subscriptions (VALIDATION).",{"description":2577},{"description":2579},"integrationsSubscribeHook",{"path":2630,"method":400,"summary":2631,"description":2632,"tags":2633,"responses":2634,"actionName":2652},"\u002Fapi\u002Fv1\u002Fintegrations\u002Fme","Who am I (integrations)","Checks an API key and names the space it opens. Automation platforms (Zapier, Make, n8n) call it when a user connects bannx, and show `spaceName` as the connection label. Any valid key works; `scopes.apiEndpoints` lists the REST scopes the key carries (absent = every scope).",[2569],{"200":2635,"401":2650},{"description":2636,"content":2637},"The key's space.",{"application\u002Fjson":2638},{"schema":2639},{"type":2512,"properties":2640},{"spaceId":2641,"spaceName":2642,"tokenName":2643,"creditsRemaining":2644,"scopes":2646},{"type":2505},{"type":2505,"nullable":2449},{"type":2505,"nullable":2449},{"type":2645,"nullable":2449},"number",{"type":2512,"nullable":2449,"properties":2647},{"apiEndpoints":2648},{"type":2524,"items":2649},{"type":2505},{"description":2651},"Missing or invalid API key (AUTH_REQUIRED, TOKEN_INVALID, TOKEN_EXPIRED).","integrationsMe",{"path":2654,"method":400,"summary":2655,"description":2656,"tags":2657,"parameters":2658,"responses":2664,"actionName":2669},"\u002Fapi\u002Fv1\u002Fintegrations\u002Frenders","Recent renders (integrations)","The key's space's latest successful renders, newest first, each shaped like a `render.completed` event: `{ id, event, templateId, format, url, timestamp }`. Automation platforms use it as sample data for a \"New render\" trigger. Bearer API key with the `template.read` scope.",[2569],[2659,2661],{"in":2479,"name":894,"required":2481,"description":2660},"Only renders of this template.",{"in":2479,"name":2662,"required":2481,"description":2663},"limit","1-50. Default 3.",{"200":2665,"401":2667},{"description":2666},"JSON { list: [{ id, event, templateId, format, url, timestamp }] }",{"description":2668},"Missing or invalid API key, or the key lacks the template.read scope (SCOPE_DENIED).","integrationsRecentRenders",{"path":2671,"method":400,"summary":2672,"description":2673,"tags":2674,"parameters":2675,"responses":2678,"actionName":2684},"\u002Fapi\u002Fv1\u002Fintegrations\u002Ftemplates\u002F:id\u002Ffields","Template fields (integrations)","A template's variables as form fields — key, label, type, required, default and choices — so an automation platform can build the render form. Bearer API key with the `template.read` scope. Types: string, text (long text), number, integer, boolean, image (an image URL), color, list and object (both sent as JSON text, or a list as comma-separated text). Also says whether the template animates, so the form can default to a video format, and lists its saved variations.",[2569],[2676],{"in":2464,"name":974,"required":2449,"description":2677},"Template ID",{"200":2679,"401":2681,"404":2682},{"description":2680},"JSON { id, name, width, height, animated, durationSeconds, fields: [{ key, label, type, required, default?, helpText?, choices? }], variations: [{ id, name }] }",{"description":2668},{"description":2683},"No template with that id in the key's space (TEMPLATE_NOT_FOUND).","integrationsTemplateFields",{"path":2686,"method":2558,"summary":2687,"description":2688,"tags":2689,"parameters":2690,"requestBody":2692,"responses":2703,"actionName":2713},"\u002Fapi\u002Fv1\u002Fintegrations\u002Ftemplates\u002F:id\u002Frender","Render a template (integrations)","Renders like `POST \u002Fapi\u002Fv1\u002Ftemplates\u002F{id}\u002Frender` and takes the same fields except `raw`, but `variables` may be form text: each value is converted to its variable's type (numbers, booleans, a list as JSON or comma-separated text, an object as JSON), undeclared names are dropped and empty values keep the template's default. Without `callbackUrl` the answer is the render route's JSON. With `callbackUrl` it answers 202 at once and POSTs that JSON to `callbackUrl` when the render finishes, or `{ ok: false, templateId, error: { code, message, status } }` when it fails: for clips that outlast an automation platform's step limit. `callbackUrl` must be a public HTTPS URL. A server restart mid-render loses an async render and no callback arrives. Bearer API key with the `template.render` scope; costs what the same render costs.",[2569],[2691],{"in":2464,"name":974,"required":2449,"description":2677},{"required":2449,"content":2693},{"application\u002Fjson":2694},{"schema":2695},{"type":2512,"properties":2696},{"callbackUrl":2697,"format":2699,"variables":2701},{"type":2505,"description":2698},"Public HTTPS URL that receives the render result. Omit to render and answer in one request.",{"type":2505,"description":2700},"Output format, as on the render route. Default png.",{"type":2512,"description":2702},"Variable values by name; text is converted to each variable's type.",{"200":2704,"202":2706,"400":2708,"401":2710,"404":2712},{"description":2705},"Without callbackUrl: the render route's JSON { ok, templateId, format, url, creditsCharged, balanceAfter, … }.",{"description":2707},"With callbackUrl: JSON { ok: true, status: \"rendering\", templateId } — the result arrives at callbackUrl.",{"description":2709},"callbackUrl is not a public HTTPS URL (VALIDATION).",{"description":2711},"Missing or invalid API key, or the key lacks the template.render scope (SCOPE_DENIED).",{"description":2683},"integrationsRenderWithCallback",{"path":2715,"method":400,"summary":2716,"description":2717,"tags":2718,"parameters":2719,"responses":2727,"actionName":2731},"\u002Fapi\u002Fv1\u002Fintegrations\u002Ftemplates\u002Findex","List templates (integrations)","The key's space templates, most recently updated first, for a template picker on an automation platform. Bearer API key with the `template.read` scope. `search` matches the name or description.",[2569],[2720,2723,2725],{"in":2479,"name":2721,"required":2481,"description":2722},"search","Text the name or description contains.",{"in":2479,"name":2480,"required":2481,"description":2724},"1-based page. Default 1.",{"in":2479,"name":2484,"required":2481,"description":2726},"Rows per page, 1-100. Default 50.",{"200":2728,"401":2730},{"description":2729},"JSON { list: [{ id, name, description, type, width, height, updatedOn }], count, page, perPage, pagesCount }",{"description":2668},"integrationsListTemplates",{"path":2733,"method":400,"summary":2734,"description":2735,"tags":2736,"group":2737,"parameters":2738,"responses":2751,"actionName":2758},"\u002Fapi\u002Fv1\u002Fpublic\u002Fcontent\u002F:collection\u002F:slug","Get an entry","Read a single PUBLISHED entry by slug. Authenticate with a content.read API key (Authorization: Bearer …). The slug is matched against the collection's configured preview.slugField (defaults to \"slug\"). Only liveData is returned; use ?depth= to resolve references and ?variants= for personalization.",[2737],"Content",[2739,2742,2745,2748],{"in":2464,"name":2740,"required":2449,"description":2741},"collection","The collection's API name",{"in":2464,"name":2743,"required":2449,"description":2744},"slug","The entry slug",{"in":2479,"name":2746,"required":2481,"description":2747},"depth","Resolve reference fields to this depth (default 0)",{"in":2479,"name":2749,"required":2481,"description":2750},"variants","Comma-separated variant ids; returns personalization-resolved values",{"200":2752,"401":2754,"404":2756},{"description":2753},"JSON { doc } — the published entry",{"description":2755},"Missing or invalid API token",{"description":2757},"Collection or entry not found","publicGetContentBySlug",{"path":2760,"method":400,"summary":2761,"description":2762,"tags":2763,"group":2737,"parameters":2764,"responses":2771,"actionName":2777},"\u002Fapi\u002Fv1\u002Fpublic\u002Fcontent\u002F:collection\u002Findex","List entries","List PUBLISHED entries in a collection. Authenticate with a content.read API key (Authorization: Bearer …). Only liveData is returned — never drafts. Values under `data` are keyed by field API name. Supports pagination, reference resolution (?depth=), and personalization (?variants=).",[2737],[2765,2766,2767,2769,2770],{"in":2464,"name":2740,"required":2449,"description":2741},{"in":2479,"name":2480,"required":2481,"description":2482},{"in":2479,"name":2484,"required":2481,"description":2768},"Items per page (default 20)",{"in":2479,"name":2746,"required":2481,"description":2747},{"in":2479,"name":2749,"required":2481,"description":2750},{"200":2772,"401":2774,"404":2775},{"description":2773},"JSON { list, count, pagesCount } of published entries",{"description":2755},{"description":2776},"Collection not found","publicListContent",{"path":2779,"method":2558,"summary":2780,"description":2781,"tags":2782,"parameters":2784,"requestBody":2786,"responses":2844,"actionName":2857},"\u002Fapi\u002Fv1\u002Ftemplates\u002F:id\u002Fbulk","Bulk render","Render one file per row of `rows` (each row is variable values by name) and pack them into a ZIP — or, with `format: \"pdf\"` and `output: \"pdf\"`, merge every row into one PDF. Queued: the response is a job id — poll `GET \u002Fapi\u002Fv1\u002Ftemplates\u002Fbulk\u002F{jobId}` for progress and the download URL. Bearer API key with the `template.render` scope; credits for every row are reserved up front.",[2783],"Creatives",[2785],{"in":2464,"name":974,"required":2449,"description":2677},{"required":2449,"content":2787},{"application\u002Fjson":2788},{"schema":2789},{"type":2512,"required":2790,"properties":2792},[2791],"rows",{"rows":2793,"format":2796,"pages":2805,"output":2809,"dpi":2813,"scale":2818,"size":2821,"fit":2823,"fps":2828,"quality":2831,"variation":2836,"variants":2838,"brand":2842},{"type":2524,"items":2794,"description":2795},{"type":2512},"One object per output: variable values by name. Optional `id` \u002F `name` keys name the file; a reserved `_filename` key sets the file name exactly (no extension, never passed to the template). Reserved `_variation` (a saved variation id or name, or several comma-separated) renders that row with its own variation in place of the run's; `_scene` (still formats, counted from 0) renders that page of the row instead of the first. A dotted key fills part of an object or list variable (`to.name`, `items.0.qty`) and keeps the template's saved values for the rest; a string holding JSON (`{…}` \u002F `[…]`) fills an object or list variable. Max 500.",{"type":2505,"enum":2797,"description":2804},[2798,2799,2800,926,2801,2802,2803],"png","webp","svg","mp4","webm","gif","Output format for every row. Default png.",{"type":2505,"enum":2806,"description":2808},[2807],"all","`all`: every page of a still template as its own file, per row (`\u003Crow>-01-\u003Cpage>.png`, …), each page costing a still's credits. png, webp or svg only, and not with a row `_scene`.",{"type":2505,"enum":2810,"description":2812},[2811,926],"zip","`zip` (default): one file per row in a ZIP. `pdf`: every row's pages merged, in row order, into one PDF — only with `format: \"pdf\"` (VALIDATION otherwise). Rows that fail are left out and listed in `errors`.",{"type":2814,"minimum":2815,"maximum":2816,"description":2817},"integer",72,1200,"PDF only: page size = pixels × 72 \u002F dpi. Unset: the template's export default, else 300 on a print size (A4, Letter, business card, 4×6 label…) so the PDF comes out at paper size, else 72 (1 px = 1 pt).",{"type":2645,"minimum":2819,"maximum":912,"description":2820},0.1,"Resolution multiplier. Default 1.",{"type":2505,"description":2822},"Render every row at another size: a size preset id or WIDTHxHEIGHT (see the single render's `size`). A row may override it with a reserved `_size` field (and `_fit`), e.g. one record as a story and another as a square in the same run.",{"type":2505,"enum":2824,"description":2827},[2825,2826],"reflow","scale","How the design adapts to `size`. Default reflow.",{"type":2814,"minimum":860,"maximum":2829,"description":2830},60,"Video formats only.",{"type":2505,"enum":2832},[2833,2834,2835],"low","medium","high",{"type":2505,"description":2837},"Saved variation (id, or its name as the editor shows it) to apply to every row — or several, as a JSON array or comma-separated string, stacked in order (at most one per single-select group). A row's `_variation` replaces it.",{"type":2524,"maxItems":1029,"items":2839,"description":2841},{"type":2505,"description":2840},"A variation id or name; a list of them (or a comma-separated string) to combine in one file; or \"\" for the row as it is set.","Render every row once per look: N rows × M looks = N × M files (at most 1000). Each entry is a variation id or name, or several to combine in one file (an array, or comma-separated), stacked on top of the row's `_variation` (else the run's `variation`); `\"\"` is the row as it is set. Files are named `\u003Crow>-\u003Clook name>` (the `\"\"` look keeps `\u003Crow>`), each costing a render.",{"type":2505,"description":2843},"Render every row under another brand of the key's space — a brandId, brand name or website URL. The template keeps its own brand. Another space's brand is BRAND_NOT_FOUND.",{"200":2845,"401":2847,"402":2849,"404":2851,"409":2853,"422":2855},{"description":2846},"JSON { jobId, total }",{"description":2848},"Missing or invalid API key, or the key lacks the template.render scope",{"description":2850},"Not enough credits for the batch",{"description":2852},"Template not found in the key's space, or `brand` names no brand of it (BRAND_NOT_FOUND)",{"description":2854},"`brand` matches several brands (BRAND_AMBIGUOUS)",{"description":2856},"Invalid body (VALIDATION), e.g. `output: \"pdf\"` with a format other than pdf","creativeBulkApi",{"path":2859,"method":400,"summary":2860,"description":2861,"tags":2862,"parameters":2863,"responses":2918,"actionName":2929},"\u002Fapi\u002Fv1\u002Ftemplates\u002F:id\u002Frender","Render a template (GET)","Render a template by ID from the URL alone: options and variables as query parameters, the file streamed back by default (`output=json` stores it and returns `{ url }`). Every query key that is not a render option is a template variable, e.g. `?title=Hello&count=3`; `variables` may also be a JSON object string, and `var.\u003Cname>` \u002F `variables[\u003Cname>]` name a variable that collides with an option. Auth: `Authorization: Bearer` or `?api_token=` — a key in the URL must be scoped to the Template Render API only (a render-only key), so leaking the URL leaks nothing else.",[2783],[2864,2865,2868,2870,2873,2876,2879,2882,2884,2887,2890,2893,2896,2899,2901,2904,2907,2910,2913,2916],{"in":2464,"name":974,"required":2449,"description":2677},{"in":2479,"name":2866,"description":2867},"api_token","A render-only API key (endpoint scope exactly template.render, no MCP tools). Alternative to the Authorization header.",{"in":2479,"name":917,"description":2869},"png (default), webp, svg, pdf, webm, mp4, gif, zip, html5",{"in":2479,"name":2871,"description":2872},"clickUrl","Required for html5: absolute HTTP(S) destination URL",{"in":2479,"name":2874,"description":2875},"loops","HTML5 repetitions: 1–10, default 1",{"in":2479,"name":2877,"description":2878},"network","HTML5 network preset: generic (default), google-ads, dv360, cm360, amazon-dsp, adroll",{"in":2479,"name":2880,"description":2881},"output","`json` to store the file and return { url, timings } instead of the bytes",{"in":2479,"name":2826,"description":2883},"Resolution multiplier 0.25–4",{"in":2479,"name":2885,"description":2886},"quality","standard | high",{"in":2479,"name":2888,"description":2889},"scene","Still formats: scene index. Omit on a pdf of a still (non-animated) template to get every scene as a page.",{"in":2479,"name":2891,"description":2892},"frame","Still formats: frame index within the scene",{"in":2479,"name":2894,"description":2895},"nodeId","Still formats: render one layer",{"in":2479,"name":2897,"description":2898},"variation","Saved variation id, or several comma-separated (stacked in order; at most one per single-select group)",{"in":2479,"name":332,"description":2900},"Render with another brand of the key's space for this render only: a brandId, brand name or the brand's website URL. The template keeps its own brand. Another space's brand is BRAND_NOT_FOUND (404); a name matching several brands is BRAND_AMBIGUOUS (409).",{"in":2479,"name":2902,"description":2903},"brandVariant","Brand campaign variant id(s), comma-separated",{"in":2479,"name":2905,"description":2906},"draft","`true` renders the current document instead of the published version",{"in":2479,"name":2908,"description":2909},"size","Another output size: a preset id (og, story, leaderboard, …) or WIDTHxHEIGHT; the template is not changed",{"in":2479,"name":2911,"description":2912},"fit","reflow (default) | scale — how the design adapts to `size`",{"in":2479,"name":2914,"description":2915},"dpi","PDF only: print resolution 72–1200 (page = pixels × 72 \u002F dpi points). Default: the template's exportDefaults.dpi, else 300 on a print-size template, else 72",{"in":2479,"name":339,"description":2917},"JSON object of variables (optional — bare keys work too)",{"200":2919,"401":2921,"403":2923,"404":2925,"409":2927},{"description":2920},"The rendered file (default; `x-credits-charged` \u002F `x-credits-balance` headers carry what it cost, and on a template with verified documents on `x-credential-id` \u002F `x-credential-url` name the document it issued), or JSON { ok, templateId, format, url, timings, creditsCharged, balanceAfter, brand?, credential? } with output=json — `credential` { id, url, code, reused } is the verified document this render issued",{"description":2922},"Missing or invalid API key",{"description":2924},"The key lacks the template.render scope, or a URL key is not render-only, or the space's verified documents are suspended (CREDENTIALS_SUSPENDED)",{"description":2926},"Template not found in the key's space, or `brand` names no brand of the key's space (BRAND_NOT_FOUND)",{"description":2928},"`brand` matches several brands of the space (BRAND_AMBIGUOUS)","creativeRenderApiGet",{"path":2859,"method":2558,"summary":2931,"description":2932,"tags":2933,"parameters":2934,"requestBody":2940,"responses":3007,"actionName":3075},"Render a template","Render a creative template by ID to png, webp, svg, pdf, webm, mp4, gif, zip (frame sequence), or html5 (standalone ad ZIP), with variable overrides. Bearer API key with the `template.render` scope. `{{ brand.* }}` resolves against `brand` when given (another brand of the key's space, for this render only), else the template's brand, else the space default. Returns `{ url, creditsCharged, balanceAfter }` with the uploaded render (plus `credential` when the template has verified documents on); `raw: true` (or `?format=binary`) streams the bytes instead. Send an `Idempotency-Key` header to retry safely: the same key with the same request within 24 hours returns the first JSON answer again (header `Idempotent-Replayed: true`) without rendering or charging again.",[2783],[2935,2936],{"in":2464,"name":974,"required":2449,"description":2677},{"in":2937,"name":486,"required":2481,"schema":2938,"description":2939},"header",{"type":2505},"Optional, 1-255 printable ASCII characters, kept 24 hours per space. A retry with the same key and the same request returns the first JSON answer without rendering or charging again. The same key with a different request, while the first is still running, or after a raw render is IDEMPOTENCY_CONFLICT (409, `data.reason`).",{"required":2481,"content":2941},{"application\u002Fjson":2942},{"schema":2943},{"type":2512,"properties":2944},{"format":2945,"clickUrl":2949,"loops":2951,"network":2953,"variables":2962,"scale":2964,"fps":2966,"quality":2968,"scene":2972,"frame":2974,"nodeId":2976,"variation":2978,"brandVariant":2980,"brandVariantMode":2983,"brandTokens":2988,"brand":2990,"draft":2992,"size":2995,"fit":2997,"pages":3000,"dpi":3003,"raw":3005},{"type":2505,"enum":2946,"description":2948},[2798,2799,2800,926,2802,2801,2803,2811,2947],"html5","Output format. Default png.",{"type":2505,"description":2950},"Required for html5: HTTP(S) click-through URL.",{"type":2814,"minimum":860,"maximum":1029,"description":2952},"HTML5 playback repetitions. Default 1.",{"type":2505,"enum":2954,"description":2961},[2955,2956,2957,2958,2959,2960],"generic","google-ads","dv360","cm360","amazon-dsp","adroll","HTML5 ad network preset the report is judged against. Default generic.",{"type":2512,"description":2963},"Variable overrides by name.",{"type":2645,"minimum":2965,"maximum":912,"description":2820},0.25,{"type":2814,"minimum":860,"maximum":2829,"description":2967},"Frames per second for video formats. Default 30.",{"type":2505,"enum":2969,"description":2971},[2970,2835],"standard","Render quality tier. Default from the template, else high.",{"type":2814,"description":2973},"Still formats: scene index to render. Omit on a pdf of a still (non-animated) template to get every scene as a page.",{"type":2814,"description":2975},"Still formats: frame index within the scene.",{"type":2505,"description":2977},"Still formats: render one layer instead of the artboard.",{"type":2505,"description":2979},"Saved variation id to apply before rendering — or several, as a JSON array or a comma-separated string, stacked in order: later wins on the same property; at most one per single-select group (VARIATION_CONFLICT).",{"type":2524,"items":2981,"description":2982},{"type":2505},"Brand campaign variant ids to render under. Replaces whatever the brand currently has active, so the result is deterministic. Accepts a single id or a comma-separated string too.",{"type":2505,"enum":2984,"description":2987},[2985,2986],"replace","add","How brandVariant combines with the brand's active set. Default replace.",{"type":2512,"description":2989},"Brand token values to render with, REPLACING the resolved brand. Use it to render exactly what a preview shows, unsaved edits included. Bounded in size and depth. Exclusive with `brand`.",{"type":2505,"description":2991},"Render with another brand of the key's space for this render only — a brandId, brand name or the brand's website URL (matched, never fetched). The template keeps its own brand, so concurrent renders under different brands do not race. Another space's brand (public catalog included) is BRAND_NOT_FOUND; a name matching several brands is BRAND_AMBIGUOUS with `data.candidates`.",{"type":2993,"description":2994},"boolean","Render the current (unpublished) document instead of the published version. Default false: a published template renders its published snapshot; a never-published one renders its draft.",{"type":2505,"description":2996},"Render at another size without changing the template: a size preset id (e.g. \"og\", \"story\", \"leaderboard\") or \"WIDTHxHEIGHT\" (16–8192 px a side, 64 MP max); an object { preset } or { width, height } is accepted too. The response echoes `size: { width, height, fit, preset?, from }`.",{"type":2505,"enum":2998,"description":2999},[2825,2826],"How the design adapts to `size`: reflow (layer constraints + auto-layout, default) or scale (uniform scale to fit, letterboxed).",{"type":2505,"enum":3001,"description":3002},[2807],"Every page of a still template as one still each — one page per scene, a scene repeated over data one page per item, resolved with this request's variables. Still formats only (png, webp, svg; a pdf already holds every page), exclusive with scene and nodeId, at most 50 pages (PAGE_LIMIT_EXCEEDED). Costs one still per page, reserved up front. The JSON answer is `{ pages: \u003Ccount>, pageUrls: [{ index, name, url, fileId }], zipUrl }`; with `raw` the body is a ZIP (`application\u002Fzip`) of `01-\u003Cpage name>.\u003Cext>`, `02-…`.",{"type":2814,"minimum":2815,"maximum":2816,"description":3004},"PDF only: print resolution. Page size = pixels × 72 \u002F dpi points, so a 1200 × 1800 px label at 300 is a 4 × 6 in page. Default: the template's exportDefaults.dpi, else 300 on a print-size template (A4, Letter, business card, 4×6 label…), else 72 (1 px = 1 pt). Out of range is VALIDATION (422).",{"type":2993,"description":3006},"Stream the file bytes instead of returning JSON.",{"200":3008,"401":3067,"403":3068,"404":3070,"409":3071,"422":3073},{"headers":3009,"description":3014,"content":3015},{"Idempotent-Replayed":3010},{"description":3011,"schema":3012},"`true` when this answer is the stored answer of an earlier request with the same `Idempotency-Key` (nothing was rendered or charged).",{"type":2505,"enum":3013},[1060],"JSON { ok, templateId, format, url, timings, creditsCharged, balanceAfter, brand?, variation?, still?, pages? (pdf), size?, warnings? ([{ nodeId, name, reason }] — layers skipped or drawn as a fallback, SVG\u002FPDF fallbacks, text caught mid-textAnimate, pagination and soundtrack notes) } — or the raw file when `raw`\u002Fbinary is requested (then `x-credits-charged` \u002F `x-credits-balance` headers carry the credits). With `pages: \"all\"`: { ok, templateId, format, pages (count), pageUrls: [{ index, name, url, fileId }], zipUrl, timings, creditsCharged, balanceAfter, … } — or, raw, a ZIP of the numbered stills (`x-page-count` header).",{"application\u002Fjson":3016},{"schema":3017},{"type":2512,"properties":3018},{"ok":3019,"templateId":3020,"format":3021,"url":3022,"creditsCharged":3024,"balanceAfter":3026,"brand":3028,"pages":3033,"pageUrls":3035,"zipUrl":3047,"warnings":3049,"credential":3056},{"type":2993},{"type":2505},{"type":2505},{"type":2505,"description":3023},"The uploaded render.",{"type":2645,"description":3025},"Credits this render cost the key's space (a still 1, a clip 5, a PDF 1 per page by default).",{"type":2645,"description":3027},"The space's spendable credits once this render's charge lands. Read when the credits were reserved, so other renders in the same space can move it.",{"type":2512,"properties":3029,"description":3032},{"id":3030,"name":3031},{"type":2505},{"type":2505,"nullable":2449},"Present when `brand` picked the brand for this render.",{"type":2814,"description":3034},"How many pages the output holds: a PDF's page count, or the number of stills a `pages: \"all\"` render produced.",{"type":2524,"description":3036,"items":3037},"`pages: \"all\"` only: the rendered pages, in order.",{"type":2512,"properties":3038},{"index":3039,"name":3041,"url":3043,"fileId":3045},{"type":2814,"description":3040},"0-based page (scene) index — the `scene` a single render takes",{"type":2505,"description":3042},"the page's name (a templated scene name is filled in)",{"type":2505,"description":3044},"the page's still",{"type":2505,"description":3046},"the page's media library file id — what a social post's `fileIds` take (order = slide order)",{"type":2505,"description":3048},"`pages: \"all\"` only: a ZIP of every page as `01-\u003Cname>.\u003Cext>`, `02-…`.",{"type":2524,"items":3050,"description":3055},{"type":2512,"properties":3051},{"nodeId":3052,"name":3053,"reason":3054},{"type":2505,"nullable":2449},{"type":2505,"nullable":2449},{"type":2505},"Where the output differs from the editor, and why: layers skipped or drawn as a fallback (a source that failed to load, a raster past the GPU limit, SVG\u002FPDF layers rasterized or approximated, fonts or images not embedded), text exported mid-textAnimate, PDF pagination notes and video soundtrack notes. nodeId and name are null for document-wide notes.",{"type":2512,"description":3057,"properties":3058},"Present when the template has verified documents on: the document this render issued. `{{ credential.url }}` in the design (a QR code's payload) printed `url`; raw responses carry `x-credential-id` \u002F `x-credential-url` headers instead.",{"id":3059,"url":3061,"code":3063,"reused":3065},{"type":2505,"description":3060},"Public id (22 letters and digits): GET \u002Fapi\u002Fv1\u002Fcredentials\u002F{id} checks it.",{"type":2505,"description":3062},"The document's public verify page.",{"type":2505,"description":3064},"8 characters to print beside the QR code.",{"type":2993,"description":3066},"true when the same holder (subject key) was rendered again with identical fields: the existing document was kept.",{"description":2848},{"description":3069},"The space's verified documents are suspended, so a template with them on cannot render (CREDENTIALS_SUSPENDED)",{"description":2926},{"description":3072},"`brand` matches several brands of the space (BRAND_AMBIGUOUS, see data.candidates); or the `Idempotency-Key` was used with a different request, its first request is still running, or it belongs to a finished raw render (IDEMPOTENCY_CONFLICT, `data.reason`: payload-mismatch, in-flight, raw-completed)",{"description":3074},"`pages: \"all\"` with a pdf or video format, with scene\u002FnodeId, or on an animated template, or `dpi` outside 72–1200 (VALIDATION); or the set is over 50 pages (PAGE_LIMIT_EXCEEDED)","creativeRenderApi",{"path":3077,"method":2558,"summary":3078,"description":3079,"tags":3080,"parameters":3081,"requestBody":3083,"responses":3113,"actionName":3123},"\u002Fapi\u002Fv1\u002Ftemplates\u002F:id\u002Fsigned-urls","Sign render URLs","Return signed image URLs (`\u002Fr\u002F:id?…&sig=…`) for one variable set or up to 500 rows. A signed URL needs no key or session: the signature covers the template id and every parameter, so it can sit in an email, a CRM field, an OG tag or an `\u003Cimg>` on any site. Each distinct URL renders once (charged like one still) and is served from cache after; republishing the template refreshes them. Still formats only (png, webp), scale ≤ 2, published version only. Requires the template.render scope.",[2783],[3082],{"in":2464,"name":974,"required":2449,"description":2677},{"required":2481,"content":3084},{"application\u002Fjson":3085},{"schema":3086,"example":3102},{"type":2512,"properties":3087},{"variables":3088,"rows":3090,"options":3098,"pages":3099},{"type":2512,"additionalProperties":2449,"description":3089},"Variables for ONE URL",{"type":2524,"maxItems":3091,"description":3092,"items":3093},500,"Many URLs — one per row; each row may override `options`",{"type":2512,"properties":3094},{"variables":3095,"options":3096},{"type":2512,"additionalProperties":2449},{"$ref":3097},"#\u002Fcomponents\u002Fschemas\u002FSignedRenderOptions",{"$ref":3097},{"type":2505,"enum":3100,"description":3101},[2807],"One URL per PAGE for every row: a still template's scenes (a scene repeated over data is one page per item, resolved with the row's variables), each signed with its `scene` index — so a carousel's keyless links exist before anything renders. Exclusive with `options.scene` and `nodeId`; at most 50 pages a row and 500 URLs a call (PAGE_LIMIT_EXCEEDED \u002F VALIDATION). Each returned row then carries `scene` and `page: { index, name }`.",{"rows":3103,"options":3112},[3104,3108],{"variables":3105},{"name":3106,"plan":3107},"Ada","Team",{"variables":3109},{"name":3110,"plan":3111},"Grace","Scale",{"format":2799},{"200":3114,"401":3116,"403":3117,"404":3119,"422":3121},{"description":3115},"JSON { templateId, published, urls: [{ url, path, variables, scene?, page? }] } — `published: false` means the URLs will 404 until the template is published; `scene` and `page: { index, name }` appear with `pages: \"all\"`",{"description":2922},{"description":3118},"The key lacks the template.render scope",{"description":3120},"Template not found in the key's space, or `options.brand` names no brand of it (BRAND_NOT_FOUND)",{"description":3122},"A variable name collides with a render option, an option is out of range, `pages: \"all\"` is combined with `options.scene` \u002F `nodeId` or signs more than 500 URLs (VALIDATION), or a row resolves to more than 50 pages (PAGE_LIMIT_EXCEEDED)","signTemplateRenderUrlsApi",{"path":3125,"method":400,"summary":3126,"description":3127,"tags":3128,"parameters":3129,"responses":3132,"actionName":3137},"\u002Fapi\u002Fv1\u002Ftemplates\u002Fbulk\u002F:jobId","Bulk render status","Progress of a bulk render started with `POST \u002Fapi\u002Fv1\u002Ftemplates\u002F{id}\u002Fbulk`: state, per-row counts, and on completion the download — `zipUrl` for a ZIP run, `fileUrl` for an `output: \"pdf\"` run (one merged PDF); `output` says which. Poll every few seconds until `state` is `completed` or `failed`.",[2783],[3130],{"in":2464,"name":1232,"required":2449,"description":3131},"Job id from the bulk request",{"200":3133,"404":3135},{"description":3134},"JSON { jobId, state, total, completed, succeeded, failed, currentItem?, errors, output, zipUrl?, fileUrl?, credentials? } — `credentials` ([{ row, credentialId, url, code, reused }]) lists the verified document each rendered row issued, when the template has verified documents on",{"description":3136},"No such job in the key's space","creativeBulkStatusApi",{"path":3139,"method":400,"summary":3140,"description":3141,"tags":3142,"parameters":3143,"responses":3180,"actionName":3183},"\u002Fapi\u002Fv1\u002Ftemplates\u002Fpublic","List public templates","List published community\u002Fgallery templates from their published snapshots. No authentication required.",[2405],[3144,3146,3149,3159,3160,3164,3168,3172,3174],{"in":2479,"name":2721,"required":2481,"description":3145},"Semantic + keyword search over name, description and each template's design digest (format, palette, fonts, layout), ranked by relevance (\"job application\" finds the hiring posts, \"dark editorial portrait\" finds the look); max 80 chars. Falls back to a substring match when search is unavailable.",{"in":2479,"name":3147,"required":2481,"description":3148},"category","Category filter, or \"featured\" for the curated list",{"in":2479,"name":917,"required":2481,"description":3150,"schema":3151},"Output format filter: creative (designs — also matches templates with no format set), video, doc, html-ad, mockups, backgrounds",{"type":2505,"enum":3152},[3153,3154,3155,3156,3157,3158],"creative","video","doc","html-ad","mockups","backgrounds",{"in":2479,"name":2480,"required":2481,"description":2482},{"in":2479,"name":3161,"required":2481,"description":3162,"schema":3163},"usesBrandVariables","Filter published designs: true uses brand-kit variables, false uses none",{"type":2993},{"in":2479,"name":3165,"required":2481,"description":3166,"schema":3167},"isPremium","Filter by access: true lists premium templates only, false lists free ones (anything not flagged premium)",{"type":2993},{"in":2479,"name":3169,"required":2481,"description":3170,"schema":3171},"features","Comma-separated feature tags the published snapshot must ALL carry, from its `features.tags` (e.g. data.loops, data.computation, data.class.fillable, motion.animated, layout.pagination); 1-8 tags. See the Template features section of the templates guide.",{"type":2505},{"in":2479,"name":2484,"required":2481,"description":3173},"Items per page (max 100)",{"in":2479,"name":3175,"required":2481,"description":3176,"schema":3177},"view","Row shape. `card` returns only what a gallery card shows: `_id`, `slug`, `name`, `type`, `format`, `category`, `isPremium` (when true), `createdBy`, `thumbnail` (URLs only, variants up to 960 px wide; `src` is omitted when variants exist, use the largest), `thumbnailCurrent`, `contentHash`, `usesBrandVariables`, `width`, `height`, `sampleCount` (stored sample sets), `pages` (page count of a still template whose `templateSettings.pageView` is `carousel`, when above 1: its scenes after scene `repeat` \u002F `if` resolve against the default values, so one scene repeated over a 4-item list counts 4) `communityAuthor` (`{ kind: user|space, name }`, on templates listed through a reviewed community submission) and, for videos, `video` \u002F `meta` poster URLs, plus `_lean: true`. No document, variables or design digest; fetch one template with GET \u002Fapi\u002Fv1\u002Ftemplates\u002Fpublic\u002F{id} for those. Omit for the full published row.",{"type":2505,"enum":3178},[3179],"card",{"200":3181},{"description":3182},"JSON { list, count, pagesCount }. Each row is the template as published, or a card row with view=card","listPublicTemplates",{"path":3185,"method":400,"summary":3186,"description":3187,"tags":3188,"parameters":3189,"responses":3191,"actionName":3196},"\u002Fapi\u002Fv1\u002Ftemplates\u002Fpublic\u002F:id","Get a public template","Fetch one published template by ID, as published. Only templates with publicOn are returned; private IDs 404. No authentication required.",[2405],[3190],{"in":2464,"name":974,"required":2449,"description":2677},{"200":3192,"404":3194},{"description":3193},"JSON { doc } — the template as published (creative doc under templateSettings.creative)",{"description":3195},"Template not found or not public","getPublicTemplateDoc",{"path":3198,"method":400,"summary":3199,"description":3200,"tags":3201,"parameters":3203,"responses":3219,"actionName":3224},"\u002Fapi\u002Fv1\u002Fworkflows\u002F:id\u002Fprocess","Run a workflow (GET)","Embed a workflow output. Auth is Authorization: Bearer or ?api_token=, with the workflow.process scope. GET cannot upload files. With cacheId, serves the cached output (run once via POST, then embed). Otherwise runs from query text inputs (text_\u003CnodeId> or textInputs JSON). Workflows that need an image can only be served from cache. Raw bytes by default; format=json returns metadata. See \u002Fdocs\u002Fworkflows.",[3202],"Workflows",[3204,3206,3211,3214,3217],{"in":2464,"name":974,"required":2449,"description":3205},"Workflow ID",{"in":2479,"name":917,"required":2481,"schema":3207,"description":3210},{"type":2505,"enum":3208},[853,3209],"binary","binary (default) streams the image; json returns metadata.",{"in":2479,"name":3212,"required":2481,"description":3213},"cacheId","Serve this cached output. The usual path for an \u003Cimg src>.",{"in":2479,"name":3215,"required":2481,"description":3216},"textInputs","JSON object of { nodeId: value } when there is no cacheId.",{"in":2479,"name":2866,"required":2481,"description":3218},"API key, for embedding where a header cannot be set. Same workflow.process scope as Bearer.",{"200":3220,"403":3222},{"description":3221},"Raw image bytes, or JSON metadata when format=json.",{"description":3223},"API key missing the workflow.process scope, or not scoped to a space.","processWorkflowGet",{"path":3198,"method":2558,"summary":3226,"description":3227,"tags":3228,"parameters":3229,"requestBody":3241,"responses":3254,"actionName":3262},"Run a workflow","Run a workflow and return its output. Bearer API key with the `workflow.process` scope, belonging to the workflow's space. Body is multipart\u002Fform-data. Omit `format` or pass `json` for metadata, base64 and a file URL; `format=binary` streams the raw bytes (`x-workflow-run-id`, `x-workflow-cache`). `cacheId` stores the output and later calls with the same key return it without re-running. `async=true` returns a job id immediately — poll GET \u002Fapi\u002Fv1\u002Fworkflows\u002F:id\u002Fprocess\u002Fjobs\u002F:jobId. A synchronous call waits about 55 seconds, then returns 202 while the run continues. See \u002Fdocs\u002Fworkflows.",[3202],[3230,3231,3235,3237],{"in":2464,"name":974,"required":2449,"description":3205},{"in":2479,"name":917,"required":2481,"schema":3232,"description":3234},{"type":2505,"enum":3233},[853,3209],"json (default) returns metadata; binary streams the output bytes.",{"in":2479,"name":3212,"required":2481,"description":3236},"Opt-in output cache key, 1–128 chars (A–Z a–z 0–9 . _ -).",{"in":2479,"name":3238,"required":2481,"schema":3239,"description":3240},"async",{"type":2993},"If true, enqueue the run and return a jobId.",{"required":2481,"content":3242},{"multipart\u002Fform-data":3243},{"schema":3244},{"type":2512,"properties":3245},{"file":3246,"nodeFile_\u003CnodeId>":3248,"text_\u003CnodeId>":3250,"textInputs":3252},{"type":2505,"format":3209,"description":3247},"Primary image input.",{"type":2505,"format":3209,"description":3249},"File for one input node (image or document). Replace \u003CnodeId> with that node's id.",{"type":2505,"description":3251},"Text for one text-input node. Replace \u003CnodeId> with that node's id.",{"type":2505,"description":3253},"JSON object of { nodeId: value } for every text input at once.",{"200":3255,"202":3257,"400":3259,"403":3261},{"description":3256},"JSON { ok, workflowId, runId, status, cached, durationMs, output: { url, base64, mimeType, width, height } }, or the raw bytes when format=binary.",{"description":3258},"JSON { ok, runId, status: \"running\", workflowId } when a synchronous run is still going. The run finishes in the background and workflow.executed fires.",{"description":3260},"Missing workflow id, or a cacheId that fails the key rules.",{"description":3223},"processWorkflow",{"path":3264,"method":400,"summary":3265,"description":3266,"tags":3267,"parameters":3268,"responses":3272,"actionName":3278},"\u002Fapi\u002Fv1\u002Fworkflows\u002F:id\u002Fprocess\u002Fjobs\u002F:jobId","Workflow run status","Poll a job enqueued with POST \u002Fapi\u002Fv1\u002Fworkflows\u002F:id\u002Fprocess?async=true. Bearer API key with the workflow.process scope. The job must belong to the key's space and this workflow. state moves waiting, then active, then completed or failed. See \u002Fdocs\u002Fworkflows.",[3202],[3269,3270],{"in":2464,"name":974,"required":2449,"description":3205},{"in":2464,"name":1232,"required":2449,"description":3271},"Job id returned by the async process call.",{"200":3273,"403":3275,"404":3276},{"description":3274},"JSON { jobId, workflowId, state, progress, result, failedReason }. result is set when state is completed.",{"description":3223},{"description":3277},"Job not found for this workflow and space.","getWorkflowProcessJob",24,"2026-11-21T22:20:47.585Z",[3282,3283,3284,3285,3286,3287,3288,3289,3290,3291,3292,3293,3294,3295,3296],"i-ph:arrow-right-bold","i-ph:caret-down-bold","i-ph:list","i-ph:caret-right","i-ph:caret-down","i-ph:copy","i-ph:x-logo","i-ph:youtube-logo","i-ph:instagram-logo","i-ph:linkedin-logo","i-tabler:brand-producthunt","i-ph:desktop","i-ph:sun","i-ph:moon","i-ph:translate",1795299663724]