{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"widget","kind":"endpoint","group":"share","title":"Embed a verifying widget","method":"GET","path":"/{kind}/{card}/embed","paths":[],"summary":"Show a read-only card that verifies itself in the visitor’s browser.","response":"An HTML frame, 200 pixels high and up to 560 pixels wide. These widget pages allow framing. Normal card pages do not.","parameters":[{"name":"kind","description":"u or o.","in":"path","required":true},{"name":"card","description":"A permanent card number or its current alias.","in":"path","required":true},{"name":"theme","description":"dark or light.","in":"query","required":false},{"name":"lang","description":"en or it. English is the default.","in":"query","required":false}],"sample":"/o/veil/embed","access":"public","base":"directory","notes":["Use an iframe. An alias redirects to the numbered widget with an expected-alias check."],"errors":["404 not_found","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/o/veil/embed'"}],"live":false,"responses":[{"status":200,"contentType":"text/html","description":"An HTML frame, 200 pixels high and up to 560 pixels wide. These widget pages allow framing. Normal card pages do not.","fields":[]},{"status":302,"contentType":"text/html","description":"An alias widget redirects to its permanent numeric card URL. Follow Location.","fields":[]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":404,"code":"not_found","description":"The requested card, key, alias, code or resource was not found.","action":"Check the identifier. Temporary codes and previews may already have expired or been used.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"An anonymous, signed-request or API-key allowance was exceeded.","action":"Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.","scope":"common"},{"status":500,"code":"internal_error","description":"An unexpected server error occurred. Internal details are not returned.","action":"Retry reads with bounded backoff. Check write results before sending a new signed operation.","scope":"common"},{"status":503,"code":"busy","description":"The application has reached a temporary concurrency or database limit.","action":"Wait `Retry-After` seconds and retry with bounded backoff.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"text/html","description":"Use the declared media type before choosing a parser."},{"name":"Date","value":"HTTP date","description":"Server time. Compare it with your clock when signing requests."},{"name":"Location","value":"relative URL","description":"Published card/proof address, or permanent widget redirect target."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Wait at least this long before retrying. Other 429/503 codes do not necessarily include it."}],"documentationUrl":"https://veil.rip/docs/widget","supportsBrowserFetch":false,"browserMode":"frame"}}