Settings are kebab-case attributes in HTML; in React use the camelCase form as a prop (enable-face → enableFace). Use true/false for booleans.
| Attribute |
Default |
Description |
token |
— |
Transaction token from your server. Required in production. |
domain |
https://demo.api.proveid.io |
Prove ID API address. |
lang |
tr |
UI language: tr or en. |
theme |
light |
light or dark. |
request-timeout-ms |
90000 |
API request timeout (ms). |
transaction-id |
— |
Continue a transaction that was started earlier. |
| Attribute |
Default |
Description |
card-type |
— |
Fixes the document type: IDCARD, OLDIDCARD, DRIVERCARD, PASSPORT, FOREIGNID. |
enable-card-select |
true without card-type |
Document type selection screen. |
enable-back-side |
true |
Back side step (when the document type needs it). |
enable-hologram |
false |
Hologram step (Turkish ID card and driving licence). |
enable-face |
true |
Face and liveness step. |
show-result-screen |
false with a token |
Summary screen at the end of the flow. |
show-capture-preview |
false |
Shows the image after each capture; the user picks Continue or Retake. |
skip-intro |
false |
Skips the intro animations of the document and face steps. |
enable-capture-button |
false |
A manual capture button in addition to automatic capture. |
| Attribute |
Default |
Description |
allow-desktop |
false |
Allows desktop cameras. When off, desktop users get a QR code to continue on their phone. |
allow-landscape |
false |
Allows landscape use. When off, the user is warned and capture stops. |
| Attribute |
Default |
Description |
include-images |
false |
Adds images and videos to the complete event. Left out by default for memory and privacy. |
assets-base |
Public CDN |
Root URL of the model files. See Customization. |
debug |
false |
Settings panel and console logs during development. Keep it off in production. |
| Value |
Description |
transaction-token |
Default and recommended. Works with the transaction token you create on your server. |
token |
For compatibility with legacy Web SDK integrations. Don’t use it for new integrations. |
| Value |
Description |
cookie |
Default. The token is verified once at the start of the flow and exchanged for a secure session cookie used by later requests. If the token is invalid, the flow does not start. |
header |
The token is sent with every request in an Authorization: Bearer header. |
| Value |
Description |
cloud |
Default. Captured documents and faces are sent to Prove ID and verified. |
host |
No requests to Prove ID at all. The SDK only captures and fires events; you send the media to your own service and advance the steps yourself. See Programmatic control. |
standalone |
Trial use without a token. Don’t use it in production. |