@ekyc_qoobiss/qbs-ect-cmp 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -51
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
# Evidence Collection Tool
|
|
4
|
-
|
|
5
|
-
This is a web component that can be used for user identification
|
|
6
|
-
|
|
7
|
-
## Getting Started
|
|
8
|
-
|
|
9
|
-
To start using this component install it via npm:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
npm i @ekyc_qoobiss/qbs-ect-cmp
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
The wev compoment has to be included in the html markup like this:
|
|
16
|
-
|
|
17
|
-
\*.html
|
|
18
|
-
|
|
19
|
-
```sh
|
|
20
|
-
<identification-component token="{{ token }}" order_id="{{ orderId }}" api_url="{{ apiUrl }}"></identification-component>
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
### There are two parameters:
|
|
24
|
-
|
|
25
|
-
- token - which is the token that was obtained using the API Key on the server side;
|
|
26
|
-
- order_id - is a unique ID that will be used for the current identification request when obtaining the processed data from the REST API Service;
|
|
27
|
-
- api_url - is the base api url that we have provided for you.
|
|
28
|
-
- phone_number - the preffered phone number for the OTP validation.
|
|
29
|
-
|
|
30
|
-
### Obtaining the token
|
|
31
|
-
|
|
32
|
-
To get the token you have to make a server-side GET request to this url: [apiUrl]/token
|
|
33
|
-
The authentication is done using the API Key that you received from us.
|
|
34
|
-
|
|
35
|
-
### The component will raise these events:
|
|
36
|
-
|
|
37
|
-
- 'ect-started' - when the component was loaded and initialted
|
|
38
|
-
- 'ect-error' - when a critical error has ocurred and the flow cannot continue
|
|
39
|
-
- 'ect-session-expired' - when the token has expired
|
|
40
|
-
- 'ect-completed' - when the flow has ended.
|
|
41
|
-
- 'ect-aborted' - when the flow was aborted by the user.
|
|
42
|
-
|
|
43
|
-
### Obtaining the result
|
|
44
|
-
|
|
45
|
-
To get the result of the collection process, you have to make a GET call to the endpoint [apiUrl]/validation/identity/result?orderId=[orderId]. The result will be a json with the details we have processesd. The result is encrypted using AES with a symmetrical key that you will be provided with. To be able to call the endpoint you have to use either a valid token or the API Key.
|
|
46
|
-
If the request is not yet processes, the response will be a json of this type:
|
|
47
|
-
{
|
|
48
|
-
"OrderID": "the id",
|
|
49
|
-
"Status": "[Incomplete|NotStarted|Running]"
|
|
50
|
-
}
|
|
51
|
-
When the processing has finished the response will return the encrypted data.
|