Skip to content

Commit 76ca822

Browse files
authored
docs(onboarding) - add docs about basic information (#807)
* add schema changes * finish docs * remove line
1 parent 106f096 commit 76ca822

4 files changed

Lines changed: 98 additions & 0 deletions

File tree

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Schema Changes
2+
3+
## Overview
4+
5+
This documentation tracks JSON schema version changes across the Remote Flows SDK. Use this guide to understand what changed between versions and which SDK version supports each schema.
6+
7+
**For new integrations:** Always use the latest version for each flow unless you have specific legacy requirements.
8+
9+
## Basic Information (EOR)
10+
11+
Schema versions for the Basic Information step in employee onboarding flows.
12+
13+
- **Latest: [v3](./eor/basic-information/v3/v3.md)** (SDK 1.23.0+) - **Recommended for all new integrations**
14+
- Removes unused manager/department fields
15+
- Adds Argentina acknowledgement field
16+
- Better seniority field coverage (KOR, BRA, JPN)
17+
- [v1](./basic-information/v1.md) (SDK 1.0.0+) - Legacy version, maintained for backward compatibility
18+
19+
**Quick Start (v3):**
20+
21+
```tsx
22+
<OnboardingFlow
23+
options={{
24+
jsonSchemaVersion: {
25+
employment_basic_information: 3,
26+
},
27+
}}
28+
/>
29+
```
30+
31+
## Contract Details (EOR)
32+
33+
_Coming soon_
34+
35+
## Version Support Matrix
36+
37+
Track which schema versions are supported by each SDK version.
38+
| SDK Version | Basic Information | Contract Details |
39+
|-------------|-------------------|------------------|
40+
| 1.23.0+ | v3 (recommended) | _TBD_ |
41+
| 1.0.0+ | v1 (legacy) | _TBD_ |
42+
43+
**Legend:**
44+
45+
- **Recommended** - Use this version for new integrations
46+
- **Legacy** - Maintained for backward compatibility only
47+
- **TBD** - Coming soon
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Basic Information v1
2+
3+
> ⚠️ **Legacy Version**: This schema is maintained for backward compatibility only.
4+
> New integrations should use [v3](./v3.md).
5+
6+
**Available in:** SDK 1.0.0
7+
8+
## Overview
9+
10+
Schema v1 for all countries provide fields like manager and department.
349 KB
Binary file not shown.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Basic Information v3
2+
3+
**Available in:** SDK 1.23.0
4+
5+
## Overview
6+
7+
Schema v3 is the **recommended** version from **2026-03-26**, you can use it for all countries.
8+
9+
At the current date, **2026-03-26**, the SDK will load by default v1, you only need to pass the correct version.
10+
11+
## Key Changes
12+
13+
- Manager and department field were deleted, currently no partners use these fields, if you have css to hide it, remember do delete it
14+
- Argentina ackowledge field
15+
- Seniority fields coverage in some countries like KOR, BRA, JAPAN, we know tell if a field is supported or not
16+
17+
## Visual Comparison
18+
19+
📄 **[View detailed comparison with screenshots →](./v3-changes.pdf)**
20+
21+
## Caveats
22+
23+
This schema affects to Germany and France but the SDK doesn't support it at the moment this docs are written.
24+
25+
We'll provide docs about these two countries in the future.
26+
27+
## Migration
28+
29+
```tsx
30+
// Before
31+
<OnboardingFlow {...onboardingProps} />;
32+
33+
// After
34+
<OnboardingFlow
35+
options={{
36+
jsonSchemaVersion: {
37+
employment_basic_information: 3,
38+
},
39+
}}
40+
/>;
41+
```

0 commit comments

Comments
 (0)