Skip to content

Commit 364b212

Browse files
Update README.md
1 parent a470c81 commit 364b212

File tree

1 file changed

+68
-67
lines changed

1 file changed

+68
-67
lines changed

README.md

Lines changed: 68 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
<img class="img-fluid" align="center" src="https://github.com/ExtrieveTechnologies/QuickCapture/blob/main/QuickCapture.png?raw=true" width="30%" alt="img-verification"><img align="right" class="img-fluid" padding="10px" src="https://github.com/ExtrieveTechnologies/QuickCapture/blob/main/android.png?raw=true?raw=true" alt="img-verification">
23

34
# SplicerAi Intelligent Document Analysis SDK
@@ -45,18 +46,18 @@ AiDocument DocumentObject = new AiDocument(ImagePath);
4546
```
4647
Once the document type identified same also will be available in the **TYPE** property of **DocumentObject** .Following is the response structure :
4748
```JSON
48-
//Respose JSON data
49-
{
50-
DOCNAME: "<name/type of document>",
51-
Confidence: "<Level of accuracy /High>",
52-
predictedDocs: {
53-
//If any other documents detected,
54-
//Same will list out with the confidence level
55-
Aadhaar: "HIGH"
56-
},
57-
//classification succes or not
58-
CLASSIFICATION: true/false,
59-
}
49+
//Respose JSON data
50+
{
51+
DOCNAME: "<name/type of document>",
52+
Confidence: "<Level of accuracy /High>",
53+
predictedDocs: {
54+
//If any other documents detected,
55+
//Same will list out with the confidence level
56+
Aadhaar: "HIGH"
57+
},
58+
//classification succes or not
59+
CLASSIFICATION: true/false,
60+
}
6061
```
6162

6263
2. **KYCExtract**
@@ -74,22 +75,22 @@ ExtractData Method from DocumentObject will provide the extracted data from the
7475
```
7576
Once the document data extracted, same will be available in the DATA property of DocumentObject.Following is the response structure :
7677
```JSON
77-
{
78-
DOCNAME: "AADHAAR",
79-
Confidence: "High",
80-
predictedDocs: {
81-
Aadhaar: "HIGH"
82-
},
83-
CLASSIFICATION: true,
84-
//Extracted data from KYC document
85-
KEYVALUE: {
86-
NAME: "NAME",
87-
GENDER: "MALE",
88-
DOB: "16/09/1981",
89-
AADHAARNO: "2513 5077 5668",
90-
FILENAME: ""
91-
}
92-
}
78+
{
79+
DOCNAME: "AADHAAR",
80+
Confidence: "High",
81+
predictedDocs: {
82+
Aadhaar: "HIGH"
83+
},
84+
CLASSIFICATION: true,
85+
//Extracted data from KYC document
86+
KEYVALUE: {
87+
NAME: "NAME",
88+
GENDER: "MALE",
89+
DOB: "16/09/1981",
90+
AADHAARNO: "2513 5077 5668",
91+
FILENAME: ""
92+
}
93+
}
9394
```
9495
3. **GetKYCDocList**
9596
GetKYCDocList Method from **DocumentObject** will provide the list of available KYC document.
@@ -99,36 +100,36 @@ ExtractData Method from DocumentObject will provide the extracted data from the
99100
```
100101
Following is a sample response structure :
101102
```JSON
102-
["AADHAAR","PAN","PASSPORT"]
103+
["AADHAAR","PAN","PASSPORT"]
103104
```
104105

105106
4. **KYCVerify**
106-
KYCVerify Method from **DocumentObject** will verify the KYC document with the **TYPE** provided.
107+
KYCVerify Method from **DocumentObject** will verify the KYC document with the **TYPE** provided.
107108
```java
108-
//KYCVerify will use callback function to return the result.
109-
DocumentObject.KYCVerify("PAN",handleKYCVerifytCallBack);
110-
*@param "Type of document to verify can get from GetKYCDocList Method".
111-
*@param "A callback method to capture the KYCVerification response".
112-
113-
function handleKYCVerifyCallBack(resultJson) {
114-
//Process the resultJson
115-
}
116-
117-
//Or use lambda function
118-
DocumentObject.KYCVerify("PAN",resultJson -> {
119-
//Detected response JSON
120-
});
109+
//KYCVerify will use callback function to return the result.
110+
DocumentObject.KYCVerify("PAN",handleKYCVerifytCallBack);
111+
*@param "Type of document to verify can get from GetKYCDocList Method".
112+
*@param "A callback method to capture the KYCVerification response".
113+
114+
function handleKYCVerifyCallBack(resultJson) {
115+
//Process the resultJson
116+
}
117+
118+
//Or use lambda function
119+
DocumentObject.KYCVerify("PAN",resultJson -> {
120+
//Detected response JSON
121+
});
121122
```
122123

123124
Following is a sample response structure :
124125

125126
```JSON
126-
{
127-
STATUS: true/false,
128-
//success/failure
129-
CONFIDENCE : "LOW/MEDIUM/HIGH"
130-
//if STATUS is success
131-
}
127+
{
128+
STATUS: true/false,
129+
//success/failure
130+
CONFIDENCE : "LOW/MEDIUM/HIGH"
131+
//if STATUS is success
132+
}
132133
```
133134

134135
**AADHAAR MASKING**
@@ -157,24 +158,24 @@ ActivityResultLauncher<Intent> activityResultLauncher = registerForActivityResul
157158
On AadhaarMask intent call, requires document id of previously created AiDocument Object.
158159
The respose data will be in following structure :
159160
```JSON
160-
{
161-
STATUS: true/false,
162-
//Masking activity status
163-
DESCRIPTION : "SUCCESS",
164-
//Success or failure description
165-
MASKING_STATUS : true,
166-
//Extracted data from KYC document
167-
MASKING_STATUS: {
168-
COUNT : "10",
169-
//Number of masking done
170-
AADHAAR_NO: "2513 5077 5668",
171-
//Can enable & disable in config.
172-
MASKED_METHOD: "MANUAL/SYSTEM"
173-
//Specify how the masking happened
174-
}
175-
FILE : "<File path of masked image>"
176-
//eg : "/storage/files/Splicer/SP_20240122_183209.jpg"
177-
}
161+
{
162+
STATUS: true/false,
163+
//Masking activity status
164+
DESCRIPTION : "SUCCESS",
165+
//Success or failure description
166+
MASKING_STATUS : true,
167+
//Extracted data from KYC document
168+
MASKING_STATUS: {
169+
COUNT : "10",
170+
//Number of masking done
171+
AADHAAR_NO: "2513 5077 5668",
172+
//Can enable & disable in config.
173+
MASKED_METHOD: "MANUAL/SYSTEM"
174+
//Specify how the masking happened
175+
}
176+
FILE : "<File path of masked image>"
177+
//eg : "/storage/files/Splicer/SP_20240122_183209.jpg"
178+
}
178179
```
179180

180181
---

0 commit comments

Comments
 (0)