Skip to content

Commit 210c948

Browse files
Copilotmehmet-yoti
andcommitted
Add documentation and example for brand_id usage
Co-authored-by: mehmet-yoti <[email protected]>
1 parent 2b84049 commit 210c948

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

examples/doc_scan/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,27 @@
66
1. Install the dependencies with `pip install -r requirements.txt`
77
1. Start the server `flask run --cert=adhoc`
88
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.

examples/doc_scan/app.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ def create_session():
4747
.with_preset_issuing_country("GBR")
4848
.with_success_url("{url}/success".format(url=YOTI_APP_BASE_URL))
4949
.with_error_url("{url}/error".format(url=YOTI_APP_BASE_URL))
50+
# Uncomment the line below to apply a custom brand theme
51+
# .with_brand_id("your-brand-id-here")
5052
.build()
5153
)
5254

0 commit comments

Comments
 (0)