id
stringclasses
26 values
text
stringclasses
26 values
metadata
dict
560c5164a448-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Eve Onboard APIs Table of contents Introduction Tasks Types of tasks Modes of operation Authentication Introduction Eve APIs enable seamless identification & authentication of individuals. Our RESTful APIs make onboardings risk-free & real-time for multiple sectors - banks, insurance, financial services, crypto exchanges, gaming, matrimony, and many more. Tasks The APIs are granular in nature, and can fit in all types of workflows. Our APIs are modelled around the concept of tasks. Each capability is a task type. Your servers create tasks by hitting our Tasks Endpoints over HTTP. API Doc - Tasks Types of tasks Document & Database Checks OCR - Extract data from documents Visual Authenticity Check - Identify if a document looks authentic Masking - Mask (or hide) sensitive sections of documents Verify with source - Verify document information with external source Face Checks Face compare - Authenticate a person by comparing two face images (ID to selfie, selfie to selfie, etc) Face liveness - Check if the person was present live during the onboarding Modes of operation There are 2 modes of operation - synchronous and asynchronous. Most tasks can be called using either APIs. Synchronous APIs return the response right away - Asynchronous APIs return a request ID and use a webhook mechanism to return the response back to your servers - Authentication Every request must contain headers identifying the API account as specified in the Authentication section. An API account is an entity used for authentication, authorization and tracking usage of our APIs. It consists of an account-id and api-key.
{ "source": "https://eve-docs.idfy.com/index.html" }
f9c06cfc0bf7-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. API Documentation Links Getting Started with APIs Document OCR APIs Doc Image Validation APIs Document Masking APIs Face Check APIs Database Check APIs Name Compare API Video Activity API Fetch Task Result API Postman Collection for all APIs
{ "source": "https://eve-docs.idfy.com/pages/api_documentation_links.html" }
83983d0d08de-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Video KYC Video KYC is a process widely accepted by regulators across the globe to perform a full KYC for individuals. The process helps companies achieve regulatory compliance with 90% savings over physical verification costs. Video KYC can be visualized as a workflow of 3 components: Capture and validate ID documents Capture and verify video activity Face compare between the video and validated ID documents Table of contents Capture & verify video activity Generate a link Video capture on IDfy’s web journey Checks Result Face compare Checks Result Useful Links Capture & validate ID Documents Checks Automated checks Document Validation - Check if the captured image is of the expected type and detect tampering, if any Document Verification - Optionally, you may also choose to verify the captured documents from the source Result Validation results - Is the ID card the same as what was being expected (A debit card photo should not be submitted instead of a passport) Tampering detection - Is the ID card genuine and are there any signs of alterations Optionally, verification results as well from the source of the ID document generation Capture & verify video activity Generate a link You can use our APIs to generate a link. Your user clicks the link to start the video capture. Video capture on IDfy’s web journey When the user clicks the link, he/she will be redirected to the video capture flow. Steps Consent screen (configurable) Instructions screen (simple instructions for the user)
{ "source": "https://eve-docs.idfy.com/pages/video_kyc.html" }
83983d0d08de-1
Steps Consent screen (configurable) Instructions screen (simple instructions for the user) Video activity capture. You can choose the type & the order of the activities that the user will be performing. We currently support activities like “Read random digits” and “Read static text”. In future, we will be coming up with many more simpler options. User presses submit to initiate the KYC Highlights Supported on chrome browsers across platforms Entire process takes less than 30 seconds Video is streamed real-time. The user doesn’t need to wait for uploading it Checks Automated checks Face liveness check - check to ensure that the video is captured live and is not recorded from a screen (pre-recorded video) Face consistency check - check to ensure that the same face is consistently present throughout the video Video activity check - check if an activity has been performed correctly (coming soon) Result Video link Face snapshot Video activity details (what was the user supposed to do) Video activity check (performed correctly or not) Timestamp and geostamp Face compare Checks Automated checks Face compare - check if the person in the video is the person whose ID card has been provided (This check needs to be initiated after video activity check is completed) Manual review/checks by experts IDfy experts to perform - Face compare review Document visual authenticity check Result Face compare - Comparison result (Document image vs Face snapshot from video) Document visual authenticity check - Check if a document looks like a valid document or not Useful Links Demo APK API documentation Blog News articles
{ "source": "https://eve-docs.idfy.com/pages/video_kyc.html" }
e3b627499c0a-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Knowledge Base Information Security Information security We consider security to be of utmost importance and make sure to handle all PII with care. Following are some of the highlights: All our data is always encrypted - we use TLS 1.2 for encryption in transit and AES-256 for encryption at rest. All our data is stored within the territory of India. For OCR, we only store images in memory as long as needed for OCR purposes. Once OCR is done, images are deleted. For all tasks, we store the final result that we provide in our database. This is to allow our clients to obtain the result of any task via the GET call. This result is the only place where we store PII - other than this, we do not store any sort of PII with us in any form. We can delete the result as per a predefined purge policy.
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/information_security.html" }
b80dbf5a40df-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Knowledge Base Best Practices Best Practices Recommended Image Size and Formats We support documents of the following MIME types - image/png image/jpeg image/tiff application/pdf We have observed that our extraction engine works best with images around 1MB (HD or 2K resolution). Larger images have no added advantage and only slow the processing down. Our face engine can work with even smaller images compressed to 300Kb-400KB. For best results on Android, you can use our “Right First Time” SDK to capture & upload images of documents & selfies.
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/best_practices.html" }
91f664ec35c5-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Knowledge Base Document Sharing Mechanism Document Sharing Mechanism Our APIs accept either - URLs of documents, or Documents as base64 encoded strings (Recommended size is less than 1 MB) You could use our upload endpoint to generate these URLs as well. You could also send us URLs of documents hosted on your servers. These URLs need to be accessible to our servers, but can be protected against unauthorised access using some or al l of the mechanisms below. There are several ways to protect URLs of images hosted on your servers - Use URLs which expire after a brief period of time Whitelist the IPs of our servers which fetch documents from your servers Pre-configure custom authentication headers which we could attach to every request we make to fetch documents from your service
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/Document_sharing_mechanisms.html" }
78fe661ed6cb-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Knowledge Base Table of contents Document Sharing Mechanism Best Practices Information Security User Consent Credits & Subscriptions
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/knowledge_base.html" }
cdccaf27152f-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Knowledge Base User Consent Consent Consent Text Consent Text - 1 (user has an option to provide Aadhaar, even if it is optional) Consent Text - 2 (user doesn’t have any option to provide Aadhaar) Additional Notes Regulation 5 of the Sharing of Information Regulations UI Implementation Consent Text Consent Text - 1 (user has an option to provide Aadhaar, even if it is optional) I, [name of individual], consent to [name of company] and Baldor Technologies Private Limited collecting my [names of identification documents] and storing and using the same for the purpose of [insert purpose]. I understand that the submission of my Aadhaar number is not mandatory and that I may submit any of the following in its place: [name alternate documents]. Consent Text - 2 (user doesn’t have any option to provide Aadhaar) I, [name of individual], consent to [name of company] and Baldor Technologies Private Limited collecting my [names of identification documents] and storing and using the same for the purpose of [insert purpose]. Additional Notes Kindly note the following in relation to the consent text suggested above: The consent of the individual concerned must be obtained prior to the collection of any identification documents from them We suggest the Company ensure there is some mechanism in place that can be used to record the consent provided by an individual, such that it can be retrieved and referred to for evidentiary purposes at a later time, if required
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/consent.html" }
cdccaf27152f-1
The consent text above relates only to the collection, storage, or use of identification documents for the purposes specified therein, and may not be interpreted to mean a general consent for any other purposes We invite the Company’s attention to the provisions of the Aadhaar (Sharing of Information) Regulations, 2016 (the “Sharing of Information Regulations”), and specifically, to Regulation 5 thereof, which relate to the collection, storage, and use of Aadhaar numbers for purposes other than authentication through the UIDAI Regulation 5 of the Sharing of Information Regulations The responsibility of any agency or entity other than requesting entity with respect to Aadhaar number - Any individual, agency or entity which collects Aadhaar number or any document containing the Aadhaar number, shall:- collect, store and use the Aadhaar number for a lawful purpose; inform the Aadhaar number holder the following details:- the purpose for which the information is collected whether submission of Aadhaar number or proof of Aadhaar for such purpose is mandatory or voluntary, and if mandatory, the legal provision mandating it; alternatives to submission of Aadhaar number or the document containing Aadhaar number, if any; obtain consent of the Aadhaar number holder to the collection, storage and use of his Aadhaar number for the specified purposes. Such individual, agency or entity shall not use the Aadhaar number for any purpose other than those specified to the Aadhaar number holder at the time of obtaining his Consent Such individual, agency or entity shall not share the Aadhaar number with any person without the consent of the Aadhaar number holder UI Implementation The consent of the individual concerned must be obtained prior to the collection of any ID documents from them. The user should be allowed to upload the documents only after he/she provides consent. Sample implementation for mobile -
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/consent.html" }
e2b4c5252c95-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Knowledge Base Credits & Subscriptions Credits & Subscription We follow a simple prepaid subscription model. When you subscribe to a plan, you get credits with a validity period. Credits are deducted at a task level as per the agreed rates. Our API solutions are very granular in nature, you create some tasks in series or parallel to accomplish an activity. For example, you can do a PAN OCR, Pan Verification, Face compare & Face validation to complete an onboarding journey (You will be basically performing 4 tasks). Credits will be deducted for each task on a pro-rata basis.
{ "source": "https://eve-docs.idfy.com/pages/knowledge_base/credits_subscriptions.html" }
050483cda473-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. FAQs Table of contents General Product Integration
{ "source": "https://eve-docs.idfy.com/pages/faq/faq.html" }
5934aafc0640-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. FAQs Integration Integration FAQs Integration FAQs Documentation and Changes Support Authentication Webhooks Static IPs Statuses Response times Handling Load Failures Documentation and Changes How will I get to know if you are making any updates to your APIs? Do you publish change logs? We generally make only backward compatible changes to our APIs. We shall publish new task types if we need to make a change that breaks backward compatibility. Support Who do I contact in case of integration questions? You can write to [email protected]. for any queries. Authentication Do I need to authenticate while using the APIs? Yes, every request must contain headers identifying the API account as specified in the Authentication section in the API reference. What is an API account? An API account is an entity used for authentication, authorization and tracking usage of our APIs. It consists of an account-id and api-key. Can we have multiple API accounts? Certainly. Please write to [email protected]. When should we use multiple API accounts? It is recommended to use different API accounts for different parts of your business so you can track usage, revoke access or rotate API keys for one part independently of the others. It is also recommended to use different API accounts for pre-prod and prod environments. Webhooks What is a webhook? A webhook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. The spec for our webhooks is defined in the API reference document
{ "source": "https://eve-docs.idfy.com/pages/faq/integration.html" }
5934aafc0640-1
When are webhooks called? Webhooks are called when a task gets completed, either successfully or with an error. What is the granularity of events sent on a webhook? Each webhook refers to only one task and is fired on task completion. Does the server exposing the webhook endpoint need to be located in India? Not necessary as long as you take explicit consent from the user. Is the webhook pre-configured or can we specify a webhook url per task? Our APIs allow only pre-configured webhooks which can be set by emailing us at [email protected]. Can we configure different webhook urls for different services on our side? We support multiple webhooks. Please write to [email protected]. How do you handle webhook failures? We retry a webhook failed due to 5xx error with an exponential backoff strategy. We do not retry failures with 4xx errors. We are working on a mechanism where we can notify webhook failures. Static IPs My organisation uses a firewall and would like to whitelist your IPs. Can you send me a list of IPs we should whitelist? Sure, our IPs are available here - API endpoint 35.200.245.87 Webhooks and Image Downloads 35.200.153.246 35.200.227.194 35.200.159.98 35.200.176.142 35.200.250.120 35.244.38.241 35.244.50.242 Statuses
{ "source": "https://eve-docs.idfy.com/pages/faq/integration.html" }
5934aafc0640-2
Statuses What does the status “source_down” mean? This means that one of our partners is down or not responding. For e.g.: If you’re doing a pan_verification task and you see source_down status; it means that we weren’t able to perform the task as NSDL failed to respond or is down for maintenance. Please setup an exponential retry when you see this status. Response times What’s the time for a task to be completed? Tasks take anywhere between less than a second upto 10 seconds depending on the task type. How many times can we call for the result or for how long? Ideally, you shouldn’t be polling the APIs after the request. You can create a POST webhook for us, which we can configure on our end and send the results on it post completion. If pooling is the only option you’ve, then you should implement an exponential pooling on our GET endpoint for a period of 2 min; after which the request should expire with a timeout exception. What will the response times change in case of spikes? We strive hard to avoid any degradation in response times due to increased load. Handling Load How much load can you handle? Each API account has a limit of 30 requests/sec. You can request for a higher limits by writing to [email protected]. How do you handle unexpected spikes? Requests above the assigned limit are rejected with 429 TOO MANY REQUESTS HTTP error. Failures If something fails, will we also be notified? Yes, all errors will be posted back to the webhook and also be available on the GET endpoint. However, any scheduled/unscheduled downtime will be communicated via email.
{ "source": "https://eve-docs.idfy.com/pages/faq/integration.html" }
0db37e3f0b41-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. FAQs Product Product FAQs Document Solutions Extraction Masking Verification with External Databases Face Solutions Face Compare Face Validation (Liveness) RFT (Right First Time) SDK Miscellaneous Document Solutions Extraction What is extraction? Extraction is a type of task, where our APIs read the text on ID card images & tag them. We use OCR technology to read the text & ML based classifiers to tag the data. What are the common use-cases for the OCR service? The common use-cases are - Assisting manual data entry by pre-filling the form fields Ensuring that the document provided & the data entered by the user are matching What is the average response time does an OCR request take? The processing time for an OCR request is generally less than 5 seconds. The processing time may increase in the following scenarios due to extra processing required - Image is not horizontally aligned. We first compute the rotation angle, rotate the image, and then start the OCR Image is not in JPG/PNG format. We convert the images in other formats to JPG/PNG for performing the OCR Image is of poor quality. We do some image processing to ensure better OCR results I already have my user’s data. I want to match the document with the available data. Is there a way to do that?
{ "source": "https://eve-docs.idfy.com/pages/faq/product.html" }
0db37e3f0b41-1
Yes, you can do that. In the request body, provide the available data along with the document image. We will provide a match result in the response. Match results are only provided for name, father’s name & address. For more details, please have a look at the API spec. Do I need to specify the document type for OCR? Yes, you need to select your task type based on the document. For example, there are separate task types for DL OCR & Voter Id OCR. If you select the task type as Voter Id OCR, and provide a DL Image, the request will be marked as invalid. How do you validate a document while doing OCR? In OCR, the input image is validated using text markers that are present on the ID cards. The basic validation in OCR is used to discard wrong ID images or images where the text is not readable, however it is not completely foolproof. Do you provide a confidence score with your OCR output? No, currently we do not provide a confidence score in the OCR output Can I provide both front & back images of the document in a single OCR task? Yes, you can either provide either of the following in a single OCR task - Both the front and the back images Only the front image Only the back image You do NOT need to specify the side of the image (front or back), our machines can detect that. Please note that you will be charged for every task, so we recommend that you send both the front & back images in a single task. Masking What is masking? Masking is a type of task to mask some sensitive data on a document image. We currently offer masking only for Aadhaar card, where we mask the first 8 digits of the aadhaar number. The input is an image with the complete aadhaar card The output is the link to an image with masked aadhaar number
{ "source": "https://eve-docs.idfy.com/pages/faq/product.html" }
0db37e3f0b41-2
The output is the link to an image with masked aadhaar number The masked image is provided in less than 8 seconds, and the solution works on ID card images rotated at any angles Verification with External Databases Which documents can be verified using databases? Which databases are used? We can currently verify 3 types of Indian ID documents. The checks are automated. - Individual PAN with NSDL database Company PAN with NSDL & MCA database Driving Licence with Saarthi database Voter Id with Electoral Database (NVSP) Face Solutions Face Compare What is Face Compare API? Face compare is a task type that compares 2 face images, and provides the match result. We currently provide 4 types of responses based on the thresholds that we have set - Faces match, no manual review required Faces match, manual review recommended Faces do not match, manual review recommended Faces do not match, no manual review required Can the Face Compare APIs be used for comparing a selfie with image on ID card? Yes, this is the primary use-case for our face compare APIs (for authentication). Our APIs work well in the following scenarios - Document face image is clear but of poor quality There is a difference in faces due to aging, facial hair, etc Besides this, our face compare APIs are also used for following use - Doc1 face Image vs Doc2 face image Selfie1 vs Selfie2 Face Validation (Liveness) What is Face Validation API? Face validation is a task type that checks if a live face is present in an image. Our APIs detect liveness from a single image. The primary use-case is to detect identity spoofing attempts where someone uses faces opened on a screen or faces printed on a paper. RFT (Right First Time) SDK What is the “Right First Time” SDK?
{ "source": "https://eve-docs.idfy.com/pages/faq/product.html" }
0db37e3f0b41-3
RFT (Right First Time) SDK What is the “Right First Time” SDK? RFT SDK is an android SDK to capture images of documents & faces right first time. It has functionalities to capture & upload the captured images. Capture right documents - Ensure that documents are captured correctly by identifying unreadable & incorrect images immediately. The errors in the capture are immediately highlighted to the users via a review screen Capture right selfie - Ensure that the face image is captured correctly by face detection, face orientation detection, closed eyes detection, multiple-face detection and some other features. The errors in the capture are immediately highlighted to the users via a review screen Upload images - Upload the images directly to IDfy servers & get an image link. This image link can then be used to create Tasks from the server Miscellaneous Do you provide on-premise solutions? No, we currently only provide cloud based solutions
{ "source": "https://eve-docs.idfy.com/pages/faq/product.html" }
12f96bbd1cdb-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. FAQs General General FAQs Customer Support Subscriptions / Pricing Information Security Data Storage Security Certificates / Compliances User consent Customer Support How can I raise a support ticket? What is the support process? You can drop an email to [email protected] for a prompt support. Our support team will get back to you with the resolution. Please refer the support section for details around SLAs & escalation matrix. Subscriptions / Pricing How are your APIs priced? We follow a simple prepaid subscription model. When you subscribe to a plan, you get credits with a validity period. Credits are deducted at a task level as per the agreed rates. What is a task? Our API solutions are very granular in nature, you create some tasks in series or parallel to accomplish an activity. For example, you can do a PAN OCR, Pan Verification, Face compare & Face validation to complete an onboarding journey (You will be basically performing 4 tasks). Credits will be deducted for each task. Do you charge for all requests? We only charge for the tasks that are marked as “Completed” by our system. For OCR, we mark a request as “Completed” if the image provided appears valid based on our basic validations. For example, if an image of PAN is uploaded for Aadhaar OCR, we will mark the request as Invalid, and it will not be charged for. How can I track my credits? Do you provide a dashboard for tracking the usage? You can log on to plans.idfy.com to track your credit usage & other subscription details.
{ "source": "https://eve-docs.idfy.com/pages/faq/general.html" }
12f96bbd1cdb-1
You can log on to plans.idfy.com to track your credit usage & other subscription details. Do you have any APIs to check the balance credits? We currently do not have APIs to check the balance credits. Information Security Data Storage Where are your servers located? Our servers are located in India - Google cloud platform (GCP), Mumbai region. What is your purging policy? Customer data is always purged after the completion of a task. We provide two configurable modes of purging the data - ‘Immediate’ or ‘After x minutes/hours’. We purge the document images as well as the PII data from the API request & response Security Certificates / Compliances What are the certifications that you have? We are ISO 27001 certified. For more details, refer the information security section. User consent Is user consent mandatory while capturing document images? What are the guidelines? User consent should be taken before capturing the ID cards. It is a mandatory step if you are using our APIs. For the consent guidelines, please refer the consent section.
{ "source": "https://eve-docs.idfy.com/pages/faq/general.html" }
8232e307a62f-0
IDfy - Product Hub Eve Onboard APIs Capture SDK (Android) Video KYC Knowledge BaseDocument Sharing MechanismBest PracticesInformation SecurityUser ConsentCredits & Subscriptions API Documentation Links FAQsGeneralProductIntegration Just the Docs, a documentation theme for Jekyll. Capture SDK (Android) Users often do not provide the right document images at the time of onboarding. The low first time right rate leads to leakage of the sales funnel, and additional customer acquisition costs. Our “Right First Time” SDK solves this problem and ensures that the documents are captured properly. It is an android SDK with the following capabilities - Table of contents Capabilities Capture Document Capture Selfie Upload Images Integrating the SDK Adding the SDK to your project Prerequisites Initializing the SDK Capturing Documents Capturing Selfies Uploading Images and working with EVE APIs Type of documents Error Codes Important Notes Capabilities Capture Document You can use the SDK to capture documents, and ensure that the document images are captured right first time. This also ensures that you get the best results while performing OCR on the documents. Key features include - Templates to ensure right capture of the document Readability checks - blur detection, lighting detection Incorrect document detection Beta (example - user selects PAN but uploads Aadhaar) Compression of the image to right size In case the document is not captured properly, the review screen shows an error and the user is asked to re-capture the image. Capture Selfie You can use the SDK to capture selfie/face image, and ensure that the image is captured right first time. This also ensures that you get the best results while doing face match & face liveness. Key features include - Blur detection Face orientation detection Multiple faces detection Closed eyes detection Compression of the image to right size
{ "source": "https://eve-docs.idfy.com/pages/capture_sdk/capture_sdk.html" }
8232e307a62f-1
Face orientation detection Multiple faces detection Closed eyes detection Compression of the image to right size In case the face image is not captured properly, the review screen shows an error and the user is asked to re-capture the image. Upload Images You can use this to upload images directly to idfy servers. We support encryption mechanism on this SDK (configurable) which keeps the images secure in-transit. When you upload the images, you will get an image link back. This image link can then be used to make API calls from the server. Integrating the SDK Adding the SDK to your project To download the SDK, add the following to your project’s ‘build.gradle’ file: allprojects repositories ... maven url "https://jitpack.io" maven url "https://mymavenrepo.com/repo/jeYsRLYFzkhy617P4O1I/" And then add the following line in your app module to add the dependency: implementation ‘com.idfy:rft:1.0.3’ Prerequisites Firebase: You will need to set up your app with Firebase and add in a google-services.json generated during the Firebase sign-up process. Camera permissions: You should ask your user for camera permissions when appropriate within your app. The SDK requires this permission to work. Initializing the SDK RFTSdk.init(context, accountId, token, rftConfiguration) This function will initiate the SDK and provide an instance of RFTSdk. This instance will be further used to call other functions of the SDK. context Activity Current activity context accountId string Identification token that will be shared by the IDfy team token string Authentication token that will be shared by the IDfy team rftConfiguration rftConfiguration Review screen visibility and UI elements can be optionally configured here. More details in the subsequent table
{ "source": "https://eve-docs.idfy.com/pages/capture_sdk/capture_sdk.html" }
8232e307a62f-2
Review screen visibility and UI elements can be optionally configured here. More details in the subsequent table initCallback rftSdkInitCallback RftSdkInitCallback has 2 callback functions:1. onInitSuccess allows you to access the capture and upload functions of the SDK2. OnInitFailure returns an error which would be due to invalid token or account ID RftConfigurations ReviewScreen enum enable_all ReviewScreen.ENABLE_ALL ReviewScreen.ENABLE_INCORRECT ReviewScreen.DISABLE Logo Bitmap null BitmapFactory.decodeResource(getResources(), R.drawable.logo) Logo Alignment enum LogoAlignment.CENTER LogoAlignment.LEFTLogoAlignment.CENTERLogoAlignment.RIGHT Primary Button Text Color int #ffffff Color.parseColor(“#ffffff”) Primary Button Background Color int #207d94 Color.parseColor(“#207d94”) Secondary Button Text Color int #207d94 Color.parseColor(“#207d94”) Secondary Button Background Color int #ffffff Color.parseColor(“#ffffff”) Capturing Documents RFTSdkInstance.CaptureDoc(context, docType, callback) context Activity Current activity context doc_type enum Document type (eg. ind_aadhaar_front) that is to be captured use the exact value from the type of documents table below callback RftImageCaptureCallback Instance of class/activity that implements RftImageCaptureCallback which contains 3 callback functions.1. onCorrectCapture that returns bitmap image once image is captured and validated2. onIncorrectCapture that returns bitmap image and reason for incorrect capture 3. onCaptureError that returns a RftException that contains the stacktrace of the error and the error Incorrect Capture Insights: The image is of some other document No document detected in the image The image is not readable No face detected in the image
{ "source": "https://eve-docs.idfy.com/pages/capture_sdk/capture_sdk.html" }
8232e307a62f-3
No document detected in the image The image is not readable No face detected in the image Multiple prominent faces detected in the image Face is too far from the camera Eyes are closed in the image Capturing Selfies RFTSdkInstance.CaptureFace(context, callback) context Activity Current activity context callback RftImageCaptureCallback Instance of class/activity that implements RftImageCaptureCallback which contains 3 callback functions.1. onCorrectCapture that returns bitmap image once image is captured and validated2. onIncorrectCapture that returns bitmap image and reason for incorrect capture 3. onCaptureError that returns a RftException that contains the stacktrace of the error and the error Uploading Images and working with EVE APIs RFTSdkInstance.UploadImage(accountId, token, groupId, docType, image) This function will return a self-link (image reference) of the uploaded image that will be used for task creation. accountId string account_id that will be fetched at the time of login using the token end-point* token string Authentication token that will be fetched at the time of login using the token end-point* groupId string Unique identifier to group checks for an individual profile docType string please refer towards the end of document for supported document types image bitmap This will be the image object that you will get it from RftSdkCallbackInterface callback RftUploadCallback Callback for the success or failure of this function. The response contains a link that is a reference of the stored image. Eg: https://storage.googleapis.com/rftsdk/123 The reference URL can be used to initiate EVE’s Database Checks, Document Validation & Masking and Face APIs Type of documents ind_aadhar Images or Scanned copy of an Aadhaar Card ind_pan Images or Scanned copy of an Indian Tax Card
{ "source": "https://eve-docs.idfy.com/pages/capture_sdk/capture_sdk.html" }
8232e307a62f-4
ind_pan Images or Scanned copy of an Indian Tax Card ind_voter Images or Scanned copy of Indian Voter Card ind_driving_lisence Images or Scanned copy of Indian Driving Lisence ind_passport Images or scanned copy of Indian Passport face_image Image of live face others Any other kind of document supported Optionally, to explicitly define front and back of Doc Image, append “_front” or “_back” to the doc_type. *Use the correct docType for the document being captured to ensure correct processing. Quick check: The camera and review screens will have the document name if correct parameters are passed to the CaptureDocImage function Error Codes 403 - The token has expired. A new token needs to be fetched* Important Notes The CaptureDocImage and CaptureFaceImage functions will give a Bitmap image in callback interface. UploadImage function involves a network call, so it’s recommended to use them in an asynchronous manner. IDfy’s Right First Time(RFT) SDK aids the ,Verification, OCR and Face APIs by ensuring the image captured is correct and match the requisite quality standards. Here’s a link to the same: eve-api-docs.idfy.com To get your api key, account id and token, drop an email to [email protected] Find the Github project of a test app with the SDK integrated, here! .
{ "source": "https://eve-docs.idfy.com/pages/capture_sdk/capture_sdk.html" }

No dataset card yet

Downloads last month
11