Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Onfido Android Team committed May 10, 2022
1 parent 9c9c902 commit 476d5ae
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 54 deletions.
20 changes: 13 additions & 7 deletions CHANGELOG.MD
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
are responsible for testing your translated layout in case you are using custom
translations. [More on language localisation](README.md#4-localisation)

## [12.0.0] - 2022-05-04
## [12.1.0] - 2022-05-10

### Added

- Public: Removed user consent from the public API
- Public: Added support for capture of documents for proof of address report

## [12.0.0] - 2022-05-04

### Changed

- Public: Removed the option to implement the user consent screen directly in your configuration during SDK initialization. It is now controlled by the Onfido backend. Please see our [Onfido privacy notices and consent migration guide](https://developers.onfido.com/guide/migration-guide-onfido-privacy-notices-and-consent) for further information.

## [11.5.0] - 2022-04-21

Expand Down Expand Up @@ -331,7 +337,7 @@ translations. [More on language localisation](README.md#4-localisation)

### Added

- Public: Added config to enable manual liveness capture
- Public: Added config to enable manual liveness capture

### Changed

Expand Down Expand Up @@ -392,7 +398,7 @@ translations. [More on language localisation](README.md#4-localisation)
- UI: Fixed a bug that caused the `no face found` warning to not display on the selfie capture screen
- Public: Fixed localization problems on liveness instructions
- Public: Fixed supported folded document types explanation on README
- Public: Fixed a bug that threw `InvalidDocumentFormatAndCountryCombinationException` on `NationalIdentityCaptureStepBuilder` and `DrivingLicenceCaptureStepBuilder` when configured with country code and document format except CountryCode.FR and CountryCode.IT
- Public: Fixed a bug that threw `InvalidDocumentFormatAndCountryCombinationException` on `NationalIdentityCaptureStepBuilder` and `DrivingLicenceCaptureStepBuilder` when configured with country code and document format except CountryCode.FR and CountryCode.IT
- Public: Fixed a bug that was causing sending not supported document type property to the Onfido backend.

## [5.6.0] - 2020-03-16
Expand Down Expand Up @@ -483,7 +489,7 @@ translations. [More on language localisation](README.md#4-localisation)
### Changed:
- UI: Updated README to clarify `APPLICATION_ID` term and how to obtain sandbox token
- UI: Manual capture button showed after the user click retake or back button for passport and US DL
- UI: For passports and US Driving Licenses (DL) the manual capture button is shown after the user clicks on retake or on the back button.
- UI: For passports and US Driving Licenses (DL) the manual capture button is shown after the user clicks on retake or on the back button.
- UI: The manual fallback countdown changed
- Internal: Changed token expiration identifier for the `onfido-api-client`

Expand All @@ -496,10 +502,10 @@ translations. [More on language localisation](README.md#4-localisation)

### Changed:
- Public: `onfido-api-client` dependency now bundled with the SDK, instead of getting downloaded as a transitive dependency.
- Public: Added option to disable liveness intro video (`FaceCaptureStep(FaceCaptureVariantVideo(showIntroVideo = false))`)
- Public: Added option to disable liveness intro video (`FaceCaptureStep(FaceCaptureVariantVideo(showIntroVideo = false))`)

### Removed:
- Public: Removed `check()` and `checkStatus()` functions from `OnfidoAPI`
- Public: Removed `check()` and `checkStatus()` functions from `OnfidoAPI`

## [5.0.1] - 2019-09-06

Expand Down
12 changes: 9 additions & 3 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Onfido Android SDK Migration Guide

## `11.5.0` -> `12.0.0`

### Breaking changes
- Removed the option to implement the user consent screen directly in your configuration during SDK initialization. It is now controlled by the Onfido backend. Please see our [Onfido privacy notices and consent migration guide](https://developers.onfido.com/guide/migration-guide-onfido-privacy-notices-and-consent) for further information.

### Changed strings:
- `onfido_doc_capture_header_live_guidance_doc_position_ok_accessibility`

## `11.0.0` -> `11.1.0`

### Added strings
Expand All @@ -19,6 +27,7 @@
otherwise you will get an authorization exception when creating an applicant.

### Added strings
- `onfido_doc_capture_header_capturing`
- `onfido_nfc_intro_carousel_body_dont_move`
- `onfido_nfc_intro_carousel_body_last_page`
- `onfido_nfc_intro_carousel_body_lay_flat`
Expand All @@ -28,9 +37,6 @@
### Changed strings:
- `onfido_nfc_intro_subtitle_passport`

### Added strings:
- `onfido_doc_capture_header_capturing`

### Removed strings:
- `onfido_doc_capture_header_scanning`

Expand Down
11 changes: 8 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ Average size (with Proguard enabled):

| ABI | Size |
| ----------- | :-----: |
| armeabi-v7a | 6.64 Mb |
| arm64-v8a | 7.52 Mb |
| armeabi-v7a | 6.67 Mb |
| arm64-v8a | 7.55 Mb |

#### 2.2 `onfido-capture-sdk-core`

Expand All @@ -145,7 +145,7 @@ Average size (with Proguard enabled):

| ABI | Size |
| ----------- | :-----: |
| universal | 4.11 Mb |
| universal | 4.13 Mb |


**Note**: The average sizes were measured by building the minimum possible wrappers around our SDK,
Expand Down Expand Up @@ -326,6 +326,7 @@ final FlowStep[] defaultStepsWithWelcomeScreen = new FlowStep[]{
FlowStep.WELCOME, //Welcome step with a step summary, optional
FlowStep.CAPTURE_DOCUMENT, //Document capture step
FlowStep.CAPTURE_FACE, //Face capture step
FlowStep.PROOF_OF_ADDRESS, //Proof of address capture step
FlowStep.FINAL //Final screen step, optional
};

Expand Down Expand Up @@ -503,6 +504,10 @@ FlowStep faceCaptureStep = FaceCaptureStepBuilder.forVideo()
The Face step can be configured to allow for either a photo or video flow. A custom flow **cannot** contain both the photo and video variants of the face capture. If both types of `FaceCaptureStep` are added to the same custom flow, a custom `IllegalArgumentException` will be thrown at the beginning of the flow,
with the message `"Custom flow cannot contain both video and photo variants of face capture"`.

#### Proof of address step

In the Proof of Address step, a user picks the issuing country and type of document that proves their address before capturing the document with their phone camera or uploading it.

#### Finish step

The final screen displays a completion message to the user and signals the end of the flow. This is an optional screen.
Expand Down
4 changes: 2 additions & 2 deletions sample-app/app/build.gradle
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apply plugin: 'com.android.application'


def sdkVersion = '12.0.0'
def versionCodeNumber = 1200
def sdkVersion = '12.1.0'
def versionCodeNumber = 1210

android {
compileSdkVersion 30
Expand Down
84 changes: 45 additions & 39 deletions strings.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@
<string name="onfido_app_title_country_select">Select issuing country</string>
<string name="onfido_country_select_bottom_sheet_title">Can\'t find your country?</string>
<string name="onfido_country_select_bottom_sheet_details">Sorry about that. Try using an alternative document instead.</string>
<string name="onfido_country_select_bottom_sheet_details_poa">Sorry about that. We are working on supporting more countries.</string>
<string name="onfido_country_select_bottom_sheet_link_close">Close</string>
<string name="onfido_selfie_intro_subtitle">We’ll compare this with your document</string> <!-- Capture Document/Face -->
<string name="onfido_selfie_capture_body">Keep your face within the oval</string>
Expand Down Expand Up @@ -232,7 +231,6 @@

<string name="onfido_doc_confirmation_button_primary_permit">Submit photo</string>
<string name="onfido_country_select_error_no_country_body">We’re working on adding more countries to the list. In the meantime, try using an alternative document.</string>
<string name="onfido_country_select_error_no_country_body_poa">We’re working on adding more countries to the list.</string>
<string name="onfido_selfie_intro_list_item_face_forward">Face forward and make sure your eyes are clearly visible</string>
<string name="onfido_doc_confirmation_button_primary_permit_work">Submit photo</string>
<string name="onfido_doc_confirmation_button_primary_folded_doc">Submit photo</string>
Expand Down Expand Up @@ -350,7 +348,6 @@
<string name="onfido_welcome_list_item_face_photo">Take a photo of your face</string>
<string name="onfido_welcome_list_item_face_video">Record a video of your face</string>
<string name="onfido_welcome_list_item_face_generic">Scan your face</string>
<string name="onfido_welcome_list_item_poa">Take a photo of a document with your address</string>

<string name="onfido_doc_capture_alert_no_face_title">Face not detected</string>
<string name="onfido_doc_capture_alert_no_face_detail">Make sure your face is visible</string>
Expand Down Expand Up @@ -472,42 +469,51 @@
<string name="onfido_avc_connection_error_button_secondary_restart_recording">Restart recording</string>

<!-- Proof of Address -->
<string name="onfido_poa_start_verification">Start verification</string>
<string name="onfido_poa_verify_address_title">Let\'s verify your address</string>
<string name="onfido_poa_verify_address_subtitle">You\'ll need a document that:</string>
<string name="onfido_poa_verify_address_show">Shows your &lt;b&gt;current&lt;/b&gt; address</string>
<string name="onfido_poa_verify_address_match">&lt;b&gt;Matches&lt;/b&gt; the address you used on sign up</string>
<string name="onfido_poa_verify_address_recent_doc">Is your most &lt;b&gt;recent&lt;/b&gt; document</string>
<string name="onfido_poa_select_document_title_uk">Select a UK document</string>
<string name="onfido_poa_select_document_title_non_uk">Select a document</string>
<string name="onfido_poa_select_document_subtitle">These are the documents most likely to show your current home address</string>
<string name="onfido_poa_select_document_bank_uk">Bank or building society statement</string>
<string name="onfido_poa_select_document_bank_non_uk">Bank statement</string>
<string name="onfido_poa_select_document_bank_description">e-statements accepted</string>
<string name="onfido_poa_select_document_utility_bill">Utility bill</string>
<string name="onfido_poa_select_document_utility_bill_description">Gas, electricity, water, landline, or broadband.\nSorry, no mobile phone bills e-statements accepted</string>
<string name="onfido_poa_select_document_council_tax_letter">Council tax letter</string>
<string name="onfido_poa_select_document_benefits_letter">Benefits letter</string>
<string name="onfido_poa_select_document_benefits_letter_description">Government authorised household benefits e.g. Jobseeker allowance, Housing benefit, Tax credits</string>
<string name="onfido_poa_select_document_details_subtitle_1">Must have been issued in the</string>
<string name="onfido_poa_select_document_details_subtitle_2">last 3 months</string>
<string name="onfido_poa_select_document_details_subtitle_3">last 12 months</string>
<string name="onfido_poa_select_document_details_capture">Capture the entire document and make sure it clearly shows:</string>
<string name="onfido_poa_select_document_details_logo">Logo</string>
<string name="onfido_poa_select_document_details_full_name">Full name</string>
<string name="onfido_poa_select_document_details_current_address">Current address</string>
<string name="onfido_poa_select_document_details_issue_date">Issue date or summary period</string>
<string name="onfido_poa_select_document_details_upload">Upload</string>
<string name="onfido_poa_select_document_details_take_photo">Take photo</string>
<string name="onfido_poa_select_document_details_upload_text">Select document from</string>
<string name="onfido_poa_document_submission_submit_document">Submit document</string>
<string name="onfido_poa_document_submission_choose_another">Choose another</string>
<string name="onfido_poa_document_submission_retake_photo">Retake photo</string>
<string name="onfido_poa_document_submission_indications">Make sure you have uploaded the entire document page, and details are clear to read with no blur or glare</string>
<string name="onfido_poa_document_submission_enlarge_document">Enlarge document</string>
<string name="onfido_poa_document_submission_zoom_indications">Move around using one finger. Pinch to zoom.</string>
<string name="onfido_poa_document_submission_zoom_close">Close</string>
<string name="onfido_poa_doc_capture_header_generic_front">Front of address document</string>
<string name="onfido_poa_intro_button_primary">Start verification</string>
<string name="onfido_poa_intro_title">Let’s verify your address</string>
<string name="onfido_poa_intro_subtitle">You’ll need a document that:</string>
<string name="onfido_poa_intro_list_shows_address">Shows your &lt;b&gt;current&lt;/b&gt; address</string>
<string name="onfido_poa_intro_list_matches_signup">&lt;b&gt;Matches&lt;/b&gt; the address you used on sign up</string>
<string name="onfido_poa_intro_list_most_recent">Is your most &lt;b&gt;recent&lt;/b&gt; document</string>
<string name="onfido_poa_type_selection_title_uk">Select a UK document</string>
<string name="onfido_poa_type_selection_title">Select a document</string>
<string name="onfido_doc_select_subtitle_poa">These are the documents most likely to show your current home address</string>
<string name="onfido_doc_select_button_bank_statement">Bank or building society statement</string>
<string name="onfido_doc_select_button_bank_statement_non_uk">Bank statement</string>
<string name="onfido_doc_select_extra_estatements_ok">e-statements accepted</string>
<string name="onfido_doc_select_button_bill">Utility Bill</string>
<string name="onfido_doc_select_button_bill_detail">Gas, electricity, water, landline, or broadband</string>
<string name="onfido_doc_select_button_tax_letter">Council Tax Letter</string>
<string name="onfido_doc_select_button_benefits_letter">Benefits Letter</string>
<string name="onfido_doc_select_button_benefits_letter_detail">Government authorised household benefits eg. Jobseeker allowance, Housing benefit, Tax credits</string>
<string name="onfido_poa_guidance_subtitle_bank_statement">Must have been issued in the &lt;b&gt;last 3 months&lt;/b&gt;</string>
<string name="onfido_poa_guidance_subtitle_bill">Must have been issued in the &lt;b&gt;last 3 months&lt;/b&gt;</string>
<string name="onfido_poa_guidance_subtitle_benefits_letter">Must have been issued in the &lt;b&gt;last 12 months&lt;/b&gt;</string>
<string name="onfido_poa_guidance_subtitle_tax_letter">Must have been issued in the &lt;b&gt;last 12 months&lt;/b&gt;</string>
<string name="onfido_poa_guidance_instructions_label">Capture the entire document and make sure it clearly shows:</string>
<string name="onfido_poa_guidance_instructions_logo">Logo</string>
<string name="onfido_poa_guidance_instructions_full_name">Full name</string>
<string name="onfido_poa_guidance_instructions_address">Current address</string>
<string name="onfido_poa_guidance_instructions_issue_date">Issue date or summary period</string>
<string name="onfido_poa_upload_instructions_upload_button">Upload</string>
<string name="onfido_poa_upload_instructions_take_photo_button">Take photo</string>
<string name="onfido_poa_select_document_details_upload_text">Select document from</string>
<string name="onfido_poa_capture_confirm">Submit document</string>
<string name="onfido_poa_capture_choose_another">Choose another</string>
<string name="onfido_poa_capture_redo">Retake photo</string>
<string name="onfido_doc_confirmation_body">Make sure you have uploaded the entire document page, and details are clear to read with no blur or glare</string>
<string name="onfido_poa_capture_enlarge">Enlarge document</string>
<string name="onfido_poa_capture_enlarge_move">Move around using one finger. Pinch to zoom.</string>
<string name="onfido_poa_capture_enlarge_close">Close</string>
<string name="onfido_poa_capture_instructions">Front of address document</string>
<string name="onfido_poa_doc_capture_empty"></string>
<string name="onfido_poa_document_submission_empty"></string>
<string name="onfido_poa_err_invalid_file_title">Invalid File</string>
<string name="onfido_poa_err_invalid_file_message">Please choose a different file.</string>
<string name="onfido_poa_err_invalid_file_ok">OK</string>
<string name="onfido_poa_country_not_found">Sorry about that. We are working on supporting more countries.</string>
<string name="onfido_poa_welcome_text">Take a photo of a document with your address</string>
<string name="onfido_country_select_error_no_country_body_poa">We’re working on adding more countries to the list.</string>
<string name="onfido_doc_select_extra_no_mobile">Sorry, no mobile phone bills</string>
<string name="onfido_doc_select_button_bill_detail_all">Gas, electricity, water, landline, or broadband. Sorry, no mobile phone bills</string>
</resources>

0 comments on commit 476d5ae

Please sign in to comment.