You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/doc_scan/README.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,3 +6,27 @@
6
6
1. Install the dependencies with `pip install -r requirements.txt`
7
7
1. Start the server `flask run --cert=adhoc`
8
8
1. Visit `https://localhost:5000`
9
+
10
+
## Customizing the IDV Session with Brand ID
11
+
12
+
The SDK now supports applying custom brand themes to the ID Verification iframe using the `brand_id` property. This allows businesses to maintain their brand identity throughout the verification process.
13
+
14
+
### Usage
15
+
16
+
When creating a session, you can specify a `brand_id` in the SDK configuration:
17
+
18
+
```python
19
+
from yoti_python_sdk.doc_scan import SdkConfigBuilder
20
+
21
+
sdk_config = (
22
+
SdkConfigBuilder()
23
+
.with_allows_camera_and_upload()
24
+
.with_primary_colour("#2d9fff")
25
+
.with_brand_id("your-brand-id-here") # Add your brand ID here
26
+
.with_success_url("https://yoursite.com/success")
27
+
.with_error_url("https://yoursite.com/error")
28
+
.build()
29
+
)
30
+
```
31
+
32
+
The `brand_id` is optional. If not provided, the default Yoti branding will be used. Contact Yoti support to obtain a brand ID for your organization.
0 commit comments