Jincor VERIFY Service
API Endpoint
http://verify:3000/Jincor Verification is a service for verify users email, phone, and etc. 2 | The main responsibilities are:
3 |-
4 |
- Interact with a service provider 5 |
- Validation of a received code 6 |
API Endpoints Summary
8 |JWT_TOKEN should be passed for every API call in the HTTP headers, 9 | that was received from auth service.
10 |-
11 |
-
12 |
13 |/methods/{METHOD}/actions/initiate [POST]
14 | -
15 |
16 |/methods/{METHOD}/verifiers/{VERIFICATION_ID}/actions/validate [POST]
17 | -
18 |
19 |/methods/{METHOD}/verifiers/{VERIFICATION_ID} [DELETE]
20 |
Notes about google_auth
22 |-
23 |
-
24 |
When you initiate google_auth verification 1st time for selected consumer you will get
25 |totpUrito show QR code in your frontend app.
26 | -
27 |
The received secret will be TEMPORARY until you verify it first time. If secret is not verified at least 1 time and you
28 |initiatenew google_auth verification for consumer - you will get NEW secret. It’s required to ensure that user successfully stored the secret and entered correct code.
29 | -
30 |
When you want to disable 2FA - initiate verification and send
31 |removeSecret=trueparam tovalidateendpoint to remove consumer’s secret.
32 |
Resource Group ¶
Verification: Initiate ¶
Initiate verification process, with usage of specified METHOD.
34 |Headers
Content-Type: application/json
Authorization: Bearer {JWT_TOKEN}
Accept: application/vnd.jincor+json; version=1Body
{
35 | "consumer": "test@test.com",
36 | "issuer": "Jincor",
37 | "template": {
38 | "body": "Click on the <a href=\"https://service/verify-email/5RkvAr0PUe708a?code={{{CODE}}}&verificationId={{{VERIFICATION_ID}}}\">Verify Link</a> to continue registration."
39 | },
40 | "generateCode": {
41 | "length": 32,
42 | "symbolSet": [
43 | "DIGITS",
44 | "alphas",
45 | "ALPHAS"
46 | ]
47 | },
48 | "policy": {
49 | "expiredOn": "01:00:00"
50 | },
51 | "payload": {
52 | "your": "custom payload"
53 | }
54 | }Headers
Content-Type: application/jsonBody
{
55 | "status": 200,
56 | "verificationId": "dc910ae0-7c67-4ace-8ebb-9edd4b5d8b0f",
57 | "attempts": 0,
58 | "expiredOn": 1505817462,
59 | "payload": {
60 | "your": "custom payload"
61 | }
62 | }Headers
Content-Type: application/jsonBody
{
63 | "verificationId": "5028c0cd-07a9-4fa7-8d88-49edd2a44b72",
64 | "consumer": "test@test.com",
65 | "expiredOn": 1508689744,
66 | "totpUri": "otpauth://totp/:test@test.com?secret=CK53DOA3R7B2ZDMZKVOM53ZPT355ORJI&issuer=&algorithm=SHA1&digits=6&period=30",
67 | "status": 200
68 | }Headers
Content-Type: application/jsonBody
{
69 | "status": 404,
70 | "error": "Method not supported"
71 | }Headers
Content-Type: application/jsonBody
{
72 | "status": 422,
73 | "error": "Invalid request",
74 | "details": [
75 | {
76 | "path": "generateCode.length",
77 | "error": "Incorrect number format"
78 | }
79 | ]
80 | }Initiate verificationPOST/methods/{METHOD}/actions/initiate
Example: email verification /methods/email/actions/initiate.
81 | Pass uuid in policy.forcedVerificationId to force using of your verification generated id.
82 | Set up own code in policy.forcedCode to force using of your verification code (does not apply for google_auth method).
- METHOD
string(required)One of email, google_auth, phone (not implemented).
84 |
Verification: Validate ¶
Headers
Content-Type: application/json
Authorization: Bearer {JWT_TOKEN}
Accept: application/vnd.jincor+json; version=1Body
{
85 | "code": "JeDknKO0EZRBT6aFPrFQhzcCA2aqyVsHzZeJ8Vf",
86 | "removeSecret": true
87 | }Headers
Content-Type: application/jsonBody
{
88 | "status": 200,
89 | "data": {
90 | "verificationId": "dc910ae0-7c67-4ace-8ebb-9edd4b5d8b0f",
91 | "consumer": "test@test.com",
92 | "expiredOn": 1505817462,
93 | "payload": {
94 | "your": "custom payload"
95 | },
96 | "attempts": 0
97 | }
98 | }Headers
Content-Type: application/jsonBody
{
99 | "status": 404,
100 | "error": "Not found"
101 | }Headers
Content-Type: application/jsonBody
{
102 | "status": 422,
103 | "error": "Invalid code",
104 | "data": {
105 | "verificationId": "dc910ae0-7c67-4ace-8ebb-9edd4b5d8b0f",
106 | "consumer": "test@test.com",
107 | "expiredOn": 1505817462,
108 | "payload": {
109 | "your": "custom payload"
110 | },
111 | "attempts": 1
112 | }
113 | }Validate the codePOST/methods/{METHOD}/verifiers/{VERIFICATION_ID}/actions/validate
Example: code validation for the email
114 | method /methods/email/verifiers/dc910ae0-7c67-4ace-8ebb-9edd4b5d8b0f/actions/validate.
-
116 |
-
117 |
code
118 |1234qwertA(required)
119 | -
120 |
removeSecret
121 |true(optional - use it to remove secret when you want to disable 2FA for consumer)
122 |
- METHOD
string(required)One of phone, email, google_auth.
124 |- VERIFICATION_ID
string(required)
Verifications ¶
Headers
Content-Type: application/json
Authorization: Bearer {JWT_TOKEN}
Accept: application/vnd.jincor+json; version=1Headers
Content-Type: application/jsonBody
{
125 | "status": 200,
126 | "data": {
127 | "verificationId": "dc910ae0-7c67-4ace-8ebb-9edd4b5d8b0f",
128 | "consumer": "test@test.com",
129 | "expiredOn": 1505817462,
130 | "payload": {
131 | "your": "custom payload"
132 | },
133 | "attempts": 1
134 | }
135 | }Headers
Content-Type: application/jsonBody
{
136 | "status": 404,
137 | "error": "Not found"
138 | }Get verificationGET/methods/{METHOD}/verifiers/{VERIFICATION_ID}
- METHOD
string(required)One of phone, email, google_auth.
139 |- VERIFICATION_ID
string(required)
Headers
Content-Type: application/json
Authorization: Bearer {JWT_TOKEN}
Accept: application/vnd.jincor+json; version=1Headers
Content-Type: application/jsonBody
{
140 | "status": 200
141 | }Headers
Content-Type: application/jsonBody
{
142 | "status": 404,
143 | "error": "Not found"
144 | }Invalidate the codeDELETE/methods/{METHOD}/verifiers/{VERIFICATION_ID}
- METHOD
string(required)One of phone, email, google_auth.
145 |- VERIFICATION_ID
string(required)
Generated by aglio on 28 Nov 2017