South Africa Identity Number Input
SouthAfricaIdentityNumberInput is a headless input for entering South Africa's South African Identity Number, South Africa's government-issued personal identifier. It renders as <input type="text"> with autocomplete="off" to protect sensitive identifiers. It is the editable companion to SouthAfricaIdentityNumberView.
Status: beta — implemented and unit-tested in all seven frameworks; not yet exercised in a composed flow.
Implementation Notes
- Renders as
<input type="text"> - Format: Thirteen digits in the form YYMMDDSSSSCAZ: the first six encode date of birth; the next four encode sex (0000-4999 female, 5000-9999 male); the eleventh digit encodes citizenship status (0 citizen, 1 permanent resident, 2 refugee); the twelfth is a legacy field fixed at 8 on modern cards; the thirteenth is a Luhn (Modulus-10) check digit over the preceding twelve.
autocomplete="off"to protect sensitive identifiers- Supports two-way binding on the
valueprop - Companion to SouthAfricaIdentityNumberView
Props
label: string (required) — accessible label viaaria-labelvalue: string (default: "") — bindable input valuerequired: boolean (default: false) — form validationdisabled: boolean (default: false) — disabled state...restProps: any — additional HTML attributes spread onto the<input>
Usage
<Field label="South African Identity Number" required>
<SouthAfricaIdentityNumberInput label="South African Identity Number" value={value} required />
<Hint>Thirteen digits in the form YYMMDDSSSSCAZ: the first six encode date of birth; the next four encode sex (0000-4999 female, 5000-9999 male); the eleventh digit encodes citizenship status (0 citizen, 1 permanent resident, 2 refugee); the twelfth is a legacy field fixed at 8 on modern cards; the thirteenth is a Luhn (Modulus-10) check digit over the preceding twelve.</Hint>
<ErrorMessage>Please enter a valid South African Identity Number</ErrorMessage>
</Field>
ARIA
aria-label={label}— provides accessible name
When to Use
- Use in forms collecting South Africa's South African Identity Number.
- Use in administrative or national-id workflows where the identifier is required.
When Not to Use
- Do not use for displaying read-only identifiers — use
south-africa-identity-number-viewinstead. - Do not use for general text input — use
text-inputinstead. - Do not use for other countries' identifiers — use the corresponding country-specific input.
Headless
This headless component ships zero CSS. The consumer provides all styling targeting the .south-africa-identity-number-input class hook.
Testing
- Verify renders an
<input>with the correct class andtype="text" - Verify
aria-labelis set from thelabelprop - Verify
autocomplete="off" - Verify value binding works
Domain Knowledge
Thirteen digits in the form YYMMDDSSSSCAZ: the first six encode date of birth; the next four encode sex (0000-4999 female, 5000-9999 male); the eleventh digit encodes citizenship status (0 citizen, 1 permanent resident, 2 refugee); the twelfth is a legacy field fixed at 8 on modern cards; the thirteenth is a Luhn (Modulus-10) check digit over the preceding twelve.
Where to find it: Printed on the South African Smart ID Card / green bar-coded ID book, and required to register for both public (NHI-track) and private medical aid schemes.
Related components
south-africa-identity-number-view— a read-only display of South Africa's South African Identity Numbertext-input— a single-line text input field <input type="text">
References
- Wikipedia: South African identity card
Lily™ and Lily Design System™ are trademarks.