Smile Identity
Search…
⌃K

Selfie and ID Card Capture

This method will capture a selfie and then a ID card image for a tag that may be provided during initiation and if not provided this will be auto generated by the SDK and returned with a code.

Selfie and ID Capture

Selfie Capture will capture a selfie for a tag that may be provided during initiation and if not provided this will be auto generated by the SDK and returned with a code.

Import the package

import RnSmileId from 'rn-smile-id';

Capture Selfie and ID

If you want the SDK to generate a tag for you then call the method with an empty string
const data = await RnSmileId.captureSelfieAndIDCard('',null);
If you want the generate to use a custom tag send a string to the SDK with alphanumeric characters with the exception of an underscore and no spacing in them.
const data = await RnSmileId.captureSelfieAndIDCard(<STRING_TAG>,null);
This will present a screen as below:
Selfie Capture Screen

Get Results

The selfie capture process is an asynchronous process and will return an error code and a tag once done. The result looks as the below
const resultCode = data.SID_RESULT_CODE;
const resultTag = data.SID_RESULT_TAG;
If the result code is -1 AND the tag is not null or empty then the selfie capture was successful.

Optional UI Customisations

For basic UI customisation, an additional key-value object needs to be passed as second parameter when performing a call to the library's captureSelfieAndIDCard(tag:"<TAG>",config:{"key":"value"})
method, where tag is a string and config the added key-value Map containing the desired settings.

Selfie Capture Screen Customisation

  • capture_title_text: a string value for the selfie capture screen's title. Refer to Strings and Colours section for details.
  • overlay_color: a 7-character (no alpha channel) hexadecimal color string (ie. #FF0000 for red) that sets the background color for the oval overlay view in the selfie capture screen
  • overlay_alpha: an integer value ranging from 0 to 255 that controls the transparency of the oval overlay view in the selfie capture screen
  • overlay_thickness: an non-bound integer value that determines the thickness of the oval overlay's line
  • overlay_dotted: a boolean value that specifies whether the oval overlay's line should dotted or plain (the latter by default).
  • overlay_width: a non-bound integer value that sets the oval shape's width in the selfie capture screen
  • overlay_height: same as the above, for the oval shape's height
  • capturing_progress_color: a 7-character (no alpha channel) hexadecimal color string (ie. #FF0000 for red) that determines the color of the oval overlay during selfie capture
  • captured_progress_color: a 7-character (no alpha channel) hexadecimal color string (ie. #FF0000 for red) that determines the color of the oval overlay after selfie capture
  • prompt_default_text: a string that determines the default text when the selfie capture view is initialise; this refers to text view directly under the selfie capture view
  • prompt_blurry_text: a string that informs the user that selfie is blurry
  • prompt_capturing_text: a string that informs the user that the selfie capture operation is underway
  • prompt_do_smile_text: a string used to prompt the user to smile
  • prompt_compatibility_mode_text: a string for compatibility-related issue
  • prompt_face_not_found_text: a string that determines the error message when the face is not found during selfie capture
  • prompt_face_too_close_text: a string that informs the user that they're positioned outside the acceptable selfie capture distance range
  • prompt_idle_text: a string that informs the user that the selfie capture has remained idle for long
  • prompt_move_closer_text: a string that prompts the user to move closer to the camera during selfie capture
  • prompt_too_dark_text: a string used to notify the user that brightness and light intensity is low
  • capture_tip_text: a string used for the tips at the bottom of the selfie capture screen

Selfie Review Screen Customisation

  • review_title_text: a string value for the selfie review screen's title.
  • review_prompt_text: a string that determines the prompt text view on the selfie review screen; this text view refers to the one directly under the selfie image view
  • review_prompt_style: a key-value Object that determines the styling for the prompt text view (the text view directly under the the selfie image view)'s styling - similar to screen_title_style
  • review_tip_text: a string used for the tips at the bottom of the selfie capture screen
  • review_tip_style: a key-value Object that sets the styling for the tips text view (the text view directly under the prompt text view in the selfie review screen)'s styling - similar to screen_title_style
  • review_confirm_text: a string value for the confirm button (positive action)'s text
  • review_confirm_color: a 7-character (no alpha channel) hexadecimal color string (ie. #FF0000 for red) that determines the the confirm button's background color

ID Card Screen

  • id_capture_side: a string value with options 0,1,2 0 being capture front only, 1 being capture front and back and 2 being capture back only
  • id_capture_orientation: a string that determines the prompt text view on the document capture screen; this text view refers to the one directly under the selfie image view
  • id_prompt_blurry: a string that determines the prompt text view on the document capture screen whilst the SDK is capturing an image but the image is blurry
  • id_prompt_detecting_face: a string that determines the prompt text view on the document capture screen when the SDK has captured a front of id image and facial detection is in progress
  • id_prompt_face_detected:a string that determines the prompt text view on the document capture screen when the SDK has captured a front of id image and has detected a face
  • id_prompt_fit_id: a string that determines the prompt text view on the document capture screen whilst the SDK is capturing and is the default instruction to the user when all conditions are perfect for capture
  • id_prompt_flash_missing: a string that determines the prompt text view on the document capture screen whilst the SDK is capturing an image but there is no sufficient light and no flash light available on the device
  • id_prompt_insufficient_light: a string that determines the prompt text view on the document capture screen whilst the SDK is capturing an image but there is no sufficient light
  • id_prompt_loading: a string that determines the prompt text view on the document capture screen when the SDK has captured an image and quality checks are in progress
  • id_prompt_no_face_detected: a string that determines the prompt text view on the document capture screen when the SDK has captured a front of id image but there is no face that has been detected
  • id_prompt_back_id: a string that determines the prompt text view on the document capture screen when the SDK has captured a back of id image
  • id_prompt_captured_blurry: a string that determines the prompt text view on the document capture screen when the captured image is blurry
  • id_prompt_captured_dark: a string that determines the prompt text view on the document capture screen when the captured image does not have sufficient lighting
  • card_type: a string that determines the aspect ratio for the document being captured
    • card => Aspect ratio 1.4 or normal credit card sized id types
    • passport => Aspect ratio 1.6 or normal passport size ids
    • other => will default to 1.4

Basic Example

const config = {
capture_title_text: "Capturing your smile...",
review_title_text: "Review Capture"
};
RNSmileRnLib.captureSelfieAndIDCard(tag, config);