-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathidOS.apib
13200 lines (11714 loc) · 478 KB
/
idOS.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
FORMAT: 1A
HOST: https://api.idos.io/1.0/
# idOS - A flexible framework for identity solutions.
Veridu idOS is a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) framework for flexible Identity Solutions, i.e. it has resource-oriented URLs and uses HTTP response codes to indicate API errors. It also uses built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.
Support for cross-origin resource sharing is available across all endpoints, allowing you to interact securely with the API from a client-side web application (you should never expose your Private Key in any client-side code, use User Tokens or Credential Tokens instead).
To make the API as explorable as possible, API credentials have development and production modes. There is no "switch" for changing between modes, just use the appropriate credential to perform a live or test request. Requests made with test mode credentials incur no costs.
# Overview
This describes the resources that make up the official Veridu idOS API v1.0.
If you have any problems or requests, please contact support at [support@veridu.com](mailto:support@veridu.com).
## Response Envelopes
All API responses are sent inside an envelopes, separating response metadata from response content more elegantly.
### Success Envelope
#### Paginated Response
Field | Type | Description
------------------------|---------|------------
status | boolean | Response status flag (set to `true`)
data | array | Response data, array of objects
pagination.total | integer | Total items available for current query parameters
pagination.per_page | integer | Number of items per page
pagination.current_page | integer | Current page index
pagination.last_page | integer | Last page index
pagination.from | integer | First item index
pagination.to | integer | Last item index
updated | integer | Unix timestamp for last update on result set (optional field)
#### Single Item Response
Field | Type | Description
------------------------|---------|------------
status | boolean | Response status flag (set to `true`)
data | object | Response data, object
updated | integer | Unix timestamp for last update on result set (optional field)
### Error Envelope
Field | Type | Description
--------------|---------|------------
status | boolean | Response status flag (set to `false`)
error.code | integer | Same as the HTTP Status Code
error.type | string | The type of error returned
error.link | string | Link to additional information about the error
error.message | string | A descriptive error message
## Schema
All API access is over HTTPS, and accessed from the `api.idos.io` domain.
Request data can be sent as `application/x-www-form-urlencoded` or `application/json`.
Response data can be received as `application/json`, `application/javascript` or `application/xml` depending on the `Accept` header.
For JSON-P (`application/javascript`) responses, a `callback` parameter should be added to the Query String.
## Parameters
All API endpoints will accept one or more of the parameters below, added to the Query String.
Parameter | Type | Default | Values | Description
-------------|---------|---------|----------------------------------|------------
hideLinks | boolean | `true` | `true`, `false` | Suppress response's links field
failSilently | boolean | `false` | `true`, `false` | Forces a `HTTP 200 OK` response on errors
forceOutput | string | `empty` | `json`, `javascript` or `xml` | Overrides `Accept` header and forces response output format
callback | string | `jsonp` | a valid javascript function name | Callback function name for JSON-P responses
forcedError | string | `empty` | check endpoint's list of errors | Forces a response error
## Errors
Veridu idOS API uses conventional HTTP response codes to indicate the success or failure of an API request, however not all errors map cleanly onto HTTP response codes.
```bash
curl -i https://api.idos.io/1.0/profiles/myUser
```
```http
HTTP/1.1 403 Forbidden
Server: nginx
Date: Tue, 22 Dec 2015 19:32:37 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 195
Connection: keep-alive
Cache-Control: no-store,no-cache
X-Content-Type-Options: nosniff
```
```json
{
"status": false,
"error": {
"code": 403,
"type": "CREDENTIAL_MISSING",
"link": "https://veridu.com/wiki/CREDENTIAL_MISSING",
"message": "Credential details missing. Valid Credentials: Token, Private Key"
}
}
```
## Authentication
There are two ways to authenticate in Veridu idOS API: based on a User Token or on a Credential Token. Requests that require authentication will return `403 Forbidden`. You can manage your API credentials on the [Dashboard](https://dashboard.idos.io).
All tokens are based on [JSON Web Tokens](), a list of recommended libraries to generate and manage tokens can be found [here](https://jwt.io).
### User Token
This should be used by users to interact with the API. Tokens can have a long time span, perfect for mobile integrations.
#### Sent in a Header
This is the preferred method, as it safely transports the token using a HTTP Header.
```bash
curl -H "Authorization: UserToken TOKEN" https://api.idos.io/1.0/
```
#### Sent as Query String
```bash
curl https://api.idos.io/1.0/?userToken=TOKEN
```
### Credential Token
This should be used by handlers to interact with the API.
#### Sent in a Header
This is the preferred method, as it safely transports the token using a HTTP Header.
```bash
curl -H "Authorization: CredentialToken TOKEN" https://api.idos.io/1.0/
```
#### Sent as Query String
```
curl https://api.idos.io/1.0/?token=TOKEN
```
## Rate Limiting
You can check the returned HTTP headers of any API request to see your current rate limit status:
```bash
curl -i https://api.idos.io/1.0/profiles/myUser?privKey=PRIVATE-KEY
```
```http
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 22 Dec 2015 19:03:10 GMT
X-Rate-Limit-Limit: 5400
X-Rate-Limit-Remaining: 5399
X-Rate-Limit-Reset: 1450814590
```
The headers tell you everything you need to know about your current rate limit status:
Header Name | Description
-----------------------|------------
X-Rate-Limit-Limit | The maximum number of requests that the consumer is permitted to make per minute.
X-Rate-Limit-Remaining | The number of requests remaining in the current rate limit window.
X-Rate-Limit-Reset | The time at which the current rate limit window resets in UTC epoch seconds.
Once you go over the rate limit you will receive an error response:
```http
HTTP/1.1 429 Too Many Requests
Server: nginx
Date: Tue, 22 Dec 2015 19:09:23 GMT
X-Rate-Limit-Limit: 5400
X-Rate-Limit-Remaining: 0
X-Rate-Limit-Reset: 1450814590
```
## Conditional Requests
Most responses return an `ETag` header and many also return a `Last-Modified` header. You can use the values of these headers to make subsequent requests to those resources using the `If-None-Match` and `If-Modified-Since` headers, respectively. If the resource has not changed, the server will return a 304 Not Modified.
```bash
curl -i https://api.idos.io/1.0/profiles/myUser?privKey=PRIVATE-KEY
```
```http
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 22 Dec 2015 19:09:31 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 707
Connection: keep-alive
Vary: Accept-Encoding
X-Rate-Limit-Limit: 5400
X-Rate-Limit-Remaining: 5399
X-Rate-Limit-Reset: 1450814971
Last-Modified: Tue, 22 Dec 2015 19:09:18 GMT
X-Content-Type-Options: nosniff
ETag: W/"079f7567b040b8f83e9d246018d7c115cea24c3a"
Cache-Control: private, no-cache, no-store, max-age=0, must-revalidate
```
```bash
curl -i https://api.idos.io/1.0/profiles/myUser?privKey=PRIVATE-KEY -H 'If-None-Match: W/"079f7567b040b8f83e9d246018d7c115cea24c3a"'
```
```http
HTTP/1.1 304 Not Modified
Server: nginx
Date: Tue, 22 Dec 2015 19:10:12 GMT
Connection: keep-alive
X-Rate-Limit-Limit: 5400
X-Rate-Limit-Remaining: 5398
X-Rate-Limit-Reset: 1450814971
Last-Modified: Tue, 22 Dec 2015 19:09:18 GMT
X-Content-Type-Options: nosniff
ETag: W/"079f7567b040b8f83e9d246018d7c115cea24c3a"
Cache-Control: private, no-cache, no-store, max-age=0, must-revalidate
```
```bash
curl -i https://api.idos.io/1.0/profiles/myUser?privKey=PRIVATE-KEY -H 'If-Modified-Since: Tue, 22 Dec 2015 19:09:18 GMT'
```
```http
HTTP/1.1 304 Not Modified
Server: nginx
Date: Tue, 22 Dec 2015 19:10:36 GMT
Connection: keep-alive
X-Rate-Limit-Limit: 5400
X-Rate-Limit-Remaining: 5397
X-Rate-Limit-Reset: 1450814971
Last-Modified: Tue, 22 Dec 2015 19:09:18 GMT
X-Content-Type-Options: nosniff
ETag: W/"079f7567b040b8f83e9d246018d7c115cea24c3a"
Cache-Control: private, no-cache, no-store, max-age=0, must-revalidate
```
## Cross Origin Resource Sharing
The API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin.
```bash
curl -i https://api.idos.io/1.0/profiles/myUser?privKey=PRIVATE-KEY -H 'Origin: http://example.com'
```
```http
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 22 Dec 2015 19:25:00 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 707
Connection: keep-alive
Vary: Accept-Encoding
Access-Control-Allow-Origin: http://example.com
Access-Control-Max-Age: 3628800
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,DELETE,OPTIONS
Access-Control-Allow-Headers: Authorization, Content-Type, If-Modified-Since, If-None-Match, X-Requested-With
Access-Control-Expose-Headers: ETag, X-Rate-Limit-Limit, X-Rate-Limit-Remaining, X-Rate-Limit-Reset
X-Rate-Limit-Limit: 5400
X-Rate-Limit-Remaining: 5396
X-Rate-Limit-Reset: 1450814971
Last-Modified: Tue, 22 Dec 2015 19:09:18 GMT
X-Content-Type-Options: nosniff
ETag: W/"079f7567b040b8f83e9d246018d7c115cea24c3a"
Cache-Control: private, no-cache, no-store, max-age=0, must-revalidate
```
# Group General
## General Purpose Endpoints. [/]
Comprehensive list of secondary endpoints.
## List all Endpoints. [GET /]
Retrieve a complete list with all available endpoints and call methods.
+ Response 200 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "GET /",
"type": "object",
"properties": {
"status": {
"description": "Response status flag",
"type": "boolean"
},
"data": {
"description": "Response payload",
"type": "array",
"items": {
"properties": {
"name": {
"description": "Endpoint name",
"type": "string"
},
"uri": {
"description": "Endpoint URI",
"type": "string"
},
"methods": {
"description": "List of valid HTTP Methods for this Endpoint",
"type": "array",
"items": {
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH"
]
},
"minItems": 1,
"uniqueItems": true
}
}
},
"minItems": 0,
"uniqueItems": true
}
},
"required": [
"status",
"data"
]
}
# Group Company
## Company Credentials. [/companies/{companySlug}/credentials]
Also known as API Keys, a Company Credential is a way of identifying a specific Company accessing the API from a
specific origin (eg. using a plugin from website X, or from website Y).
## List all Credentials. [GET /companies/{companySlug}/credentials]
Retrieves a complete list of all credentials that belong to the requesting company.
+ Parameters
+ companySlug: `veridu-ltd` (string, required)
+ Request (application/json)
+ Headers
Authorization: IdentityToken wqxehuwqwsthwosjbxwwsqwsdi
+ Response 500 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error",
"type": "object",
"properties": {
"status": {
"description": "",
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"description": "Same as the HTTP Status Code.",
"type": "integer"
},
"type": {
"description": "The type of error returned.",
"type": "string",
"pattern": ""
},
"link": {
"description": "Link to additional information about the error and how to fix/avoid it.",
"type": "string",
"pattern": ""
},
"message": {
"description": "A descriptive error message.",
"type": "string"
}
}
}
},
"required": [
"status",
"error"
]
}
+ Response 200 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "GET /companies/{companySlug}/credentials",
"type": "object",
"properties": {
"status": {
"description": "Response status flag",
"type": "boolean"
},
"data": {
"description": "Credential response payload",
"type": "array",
"items": {
"properties": {
"company_id": {
"description": "Company owner of the Credential",
"type": "integer"
},
"name": {
"description": "Credential Name",
"type": "string",
"pattern": ""
},
"slug": {
"description": "Slug based on Credential's name",
"type": "string",
"pattern": "[a-zA-Z0-9_-]+"
},
"public": {
"description": "Credential's Public Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"private": {
"description": "Credential's Private Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"production": {
"description": "Says whether the Credential is a production credential or a development credential, defaults to false",
"type": "boolean"
},
"created_at": {
"description": "Credential's creation unixtimestamp",
"type": "integer"
},
"updated_at": {
"description": "Credential's last update unixtime",
"type": [
"integer",
"null"
]
}
}
},
"minItems": 0,
"uniqueItems": true
},
"updated": {
"description": "Unixtime of the last update",
"type": "integer"
}
},
"required": [
"status",
"data",
"updated"
]
}
## Create new Credential. [POST /companies/{companySlug}/credentials]
Creates a new credential for the requesting company.
+ Parameters
+ companySlug: `veridu-ltd` (string, required)
+ Request (application/json)
+ Headers
Authorization: IdentityToken wqxehuwqwsthwosjbxwwsqwsdi
+ Attributes
+ name: My-Credential (string) - Credential name
+ production: false (boolean) - Production flag
+ Body
{
"name": "My-Credential",
"production": "false"
}
+ Response 500 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error",
"type": "object",
"properties": {
"status": {
"description": "",
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"description": "Same as the HTTP Status Code.",
"type": "integer"
},
"type": {
"description": "The type of error returned.",
"type": "string",
"pattern": ""
},
"link": {
"description": "Link to additional information about the error and how to fix/avoid it.",
"type": "string",
"pattern": ""
},
"message": {
"description": "A descriptive error message.",
"type": "string"
}
}
}
},
"required": [
"status",
"error"
]
}
+ Response 201 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "POST /companies/{companySlug}/credentials",
"type": "object",
"properties": {
"status": {
"description": "Response status flag",
"type": "boolean"
},
"data": {
"description": "Credential response payload",
"type": "object",
"properties": {
"company_id": {
"description": "Company owner of the Credential",
"type": "integer"
},
"name": {
"description": "Credential Name",
"type": "string",
"pattern": ""
},
"slug": {
"description": "Slug based on Credential's name",
"type": "string",
"pattern": "[a-zA-Z0-9_-]+"
},
"public": {
"description": "Credential's Public Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"private": {
"description": "Credential's Private Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"production": {
"description": "Says whether the Credential is a production credential or a development credential, defaults to false",
"type": "boolean"
},
"created_at": {
"description": "Credential's creation unixtimestamp",
"type": "integer"
},
"updated_at": {
"description": "Credential's last update unixtime",
"type": [
"integer",
"null"
]
}
}
}
},
"required": [
"status",
"data"
]
}
## Retrieve a single Credential. [GET /companies/{companySlug}/credentials/{pubKey}]
Retrieves all public information from a Credential
+ Parameters
+ companySlug: `veridu-ltd` (string, required)
+ pubKey: `FEDCBA` (string, required)
+ Request (application/json)
+ Headers
Authorization: IdentityToken wqxehuwqwsthwosjbxwwsqwsdi
+ Response 500 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error",
"type": "object",
"properties": {
"status": {
"description": "",
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"description": "Same as the HTTP Status Code.",
"type": "integer"
},
"type": {
"description": "The type of error returned.",
"type": "string",
"pattern": ""
},
"link": {
"description": "Link to additional information about the error and how to fix/avoid it.",
"type": "string",
"pattern": ""
},
"message": {
"description": "A descriptive error message.",
"type": "string"
}
}
}
},
"required": [
"status",
"error"
]
}
+ Response 200 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "GET /companies/{companySlug}/credentials/{pubKey}",
"type": "object",
"properties": {
"status": {
"description": "Response status flag",
"type": "boolean"
},
"data": {
"description": "Credential response payload",
"type": "object",
"properties": {
"company_id": {
"description": "Company owner of the Credential",
"type": "integer"
},
"name": {
"description": "Credential Name",
"type": "string",
"pattern": ""
},
"slug": {
"description": "Slug based on Credential's name",
"type": "string",
"pattern": "[a-zA-Z0-9_-]+"
},
"public": {
"description": "Credential's Public Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"private": {
"description": "Credential's Private Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"production": {
"description": "Says whether the Credential is a production credential or a development credential, defaults to false",
"type": "boolean"
},
"created_at": {
"description": "Credential's creation unixtimestamp",
"type": "integer"
},
"updated_at": {
"description": "Credential's last update unixtime",
"type": [
"integer",
"null"
]
}
}
},
"updated": {
"description": "Unixtime of the last update",
"type": "integer"
}
},
"required": [
"status",
"data"
]
}
## Update a single Credential. [PUT /companies/{companySlug}/credentials/{pubKey}]
Updates Credential's specific information
+ Parameters
+ companySlug: `veridu-ltd` (string, required)
+ pubKey: `FEDCBA` (string, required)
+ Request (application/json)
+ Headers
Authorization: IdentityToken wqxehuwqwsthwosjbxwwsqwsdi
+ Attributes
+ name: New-Name (string) - New Credential name
+ Body
{
"name": "New-Name"
}
+ Response 500 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error",
"type": "object",
"properties": {
"status": {
"description": "",
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"description": "Same as the HTTP Status Code.",
"type": "integer"
},
"type": {
"description": "The type of error returned.",
"type": "string",
"pattern": ""
},
"link": {
"description": "Link to additional information about the error and how to fix/avoid it.",
"type": "string",
"pattern": ""
},
"message": {
"description": "A descriptive error message.",
"type": "string"
}
}
}
},
"required": [
"status",
"error"
]
}
+ Response 200 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PUT /companies/{companySlug}/credentials/{pubKey}",
"type": "object",
"properties": {
"status": {
"description": "Response status flag",
"type": "boolean"
},
"data": {
"description": "Credential response payload",
"type": "object",
"properties": {
"company_id": {
"description": "Company owner of the Credential",
"type": "integer"
},
"name": {
"description": "Credential Name",
"type": "string",
"pattern": ""
},
"slug": {
"description": "Slug based on Credential's name",
"type": "string",
"pattern": "[a-zA-Z0-9_-]+"
},
"public": {
"description": "Credential's Public Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"private": {
"description": "Credential's Private Key, generated by the API",
"type": "string",
"pattern": "[a-zA-Z0-9]{16}"
},
"production": {
"description": "Says whether the Credential is a production credential or a development credential, defaults to false",
"type": "boolean"
},
"created_at": {
"description": "Credential's creation unixtimestamp",
"type": "integer"
},
"updated_at": {
"description": "Credential's last update unixtime",
"type": [
"integer",
"null"
]
}
}
},
"updated": {
"description": "Unixtime of the last update",
"type": "integer"
}
},
"required": [
"status",
"data",
"updated"
]
}
## Deletes a single Credential. [DELETE /companies/{companySlug}/credentials/{pubKey}]
Deletes a single Credential that belongs to the target company.
+ Parameters
+ companySlug: `veridu-ltd` (string, required)
+ pubKey: `FEDCBA` (string, required)
+ Request (application/json)
+ Headers
Authorization: IdentityToken wqxehuwqwsthwosjbxwwsqwsdi
+ Response 500 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error",
"type": "object",
"properties": {
"status": {
"description": "",
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"description": "Same as the HTTP Status Code.",
"type": "integer"
},
"type": {
"description": "The type of error returned.",
"type": "string",
"pattern": ""
},
"link": {
"description": "Link to additional information about the error and how to fix/avoid it.",
"type": "string",
"pattern": ""
},
"message": {
"description": "A descriptive error message.",
"type": "string"
}
}
}
},
"required": [
"status",
"error"
]
}
+ Response 200 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "DELETE /companies/{companySlug}/credentials/{pubKey}",
"type": "object",
"properties": {
"status": {
"description": "Response status flag",
"type": "boolean"
},
"deleted": {
"description": "Number of sucessfully deleted credentials",
"type": "integer",
"minimum": 0
}
},
"required": [
"status"
]
}
## Company Hook. [/companies/{companySlug}/credentials/{pubKey}/hooks]
A Hook is a feature that allows a Company to receive updates or alerts when a User changes their data in a specific
way. If a User deletes or updates a certain attribute, a Hook will update or alert the Company in realtime.
## List all Hooks. [GET /companies/{companySlug}/credentials/{pubKey}/hooks]
Retrieves a complete list of all hooks that belong to the requesting credential.
+ Parameters
+ companySlug: `veridu-ltd` (string, required)
+ pubKey: `8b5fe9db84e338b424ed6d59da3254a0` (string, required)
+ Request (application/json)
+ Headers
Authorization: IdentityToken wqxehuwqwsthwosjbxwwsqwsdi
+ Response 500 (application/json)
+ Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error",
"type": "object",
"properties": {
"status": {
"description": "",
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"description": "Same as the HTTP Status Code.",
"type": "integer"
},
"type": {
"description": "The type of error returned.",
"type": "string",
"pattern": ""
},
"link": {
"description": "Link to additional information about the error and how to fix/avoid it.",
"type": "string",
"pattern": ""
},
"message": {
"description": "A descriptive error message.",
"type": "string"
}
}
}
},
"required": [