Guidance codes
The guidance codes a step update carries, and the line each one shows in English and Swahili.
Every step update carries a guidance code: what to tell the person right now. The ready-made screens show it for you. On your own screens, show the text from the SDK's guidance function (guidanceText in Flutter and on the web, Digid.guidanceText on Android, NidaKyc.text(for:lang:) on iOS) rather than writing your own line for each code. The function covers every code in English and Swahili, including any added later.
Codes are snake_case in JSON and on the web; the typed SDKs use their own case (Guidance.noCard in Dart, Guidance.NO_CARD in Kotlin, .noCard in Swift). An SDK older than the engine reads an unknown code as unknown; show nothing new for it.
Card steps
| Code | English | Swahili |
|---|---|---|
no_card |
Place your NIDA card inside the frame | Weka kitambulisho chako cha NIDA ndani ya fremu |
move_closer |
Move the card closer | Sogeza kitambulisho karibu zaidi |
too_close |
Move the card a little further away | Sogeza kitambulisho mbali kidogo |
blurry |
Hold steady, the image is blurry | Shikilia bila kutikisa, picha haiko wazi |
glare |
Tilt the card to avoid reflections | Inamisha kitambulisho kuepuka mng'ao |
tilted |
Hold the card flat, facing the camera | Shikilia kitambulisho sawasawa, kikielekea kamera |
hold_still |
Hold still… | Tulia kidogo… |
flip_to_back |
Now turn the card over | Sasa geuza kitambulisho upande wa nyuma |
flip_to_back appears on the back step, and also when the person shows the back first or still shows the front on the back step. See Back of the card.
Selfie step
| Code | English | Swahili |
|---|---|---|
no_face |
Position your face in the frame | Weka uso wako ndani ya fremu |
multiple_faces |
Only one person should be in view | Mtu mmoja tu aonekane |
face_too_small |
Move closer to the camera | Sogea karibu na kamera |
card_face_too_small |
Bring the card closer so its photo is clear | Sogeza kitambulisho karibu ili picha ionekane wazi |
The selfie step also returns the liveness check's prompts for the person to follow. Show them with the SDK's guidance function like any other code. Customers who sign in can find the list in the full field reference.
Any step
| Code | English | Swahili |
|---|---|---|
licence_required |
Evaluation limit reached. A digid licence is required | Kikomo cha majaribio kimefikiwa. Leseni ya digid inahitajika |
done |
Done | Imekamilika |
licence_required appears only in evaluation mode, after 50 completed sessions in one app run. See Licences and renewal.
Steps
The update's step is scan_front, scan_back, selfie or done. See Custom screens on the engine.