· 4 years ago · May 10, 2021, 02:16 PM
1{
2 "openapi": "3.0.2",
3 "info": {
4 "title": "Bespoke API - zappix version",
5 "version": "1.0.0",
6 "description": "Documents APIs available for bespoke use-cases (Professional Services).",
7 "contact": {
8 "name": "Talkdesk",
9 "url": "https://talkdesk.com"
10 }
11 },
12 "components": {
13 "securitySchemes": {
14 "Early Access": {
15 "type": "oauth2",
16 "flows": {
17 "authorizationCode": {
18 "authorizationUrl": "/oauth/authorize",
19 "tokenUrl": "/oauth/token",
20 "scopes": {
21 "bespoke-vivr-fsi:read": "Read to Visual IVR in Financial Services & Insurance (FSI) API",
22 "bespoke-vivr-fsi:write": "Write to Visual IVR in Financial Services & Insurance (FSI) API"
23 }
24 }
25 }
26 }
27 }
28 },
29 "paths": {
30 "/bespoke/visual-ivr/fsi/accounts": {
31 "get": {
32 "tags": [
33 "Visual IVR FSI Accounts"
34 ],
35 "summary": "Get all accounts from a specific contact",
36 "security": [
37 {
38 "Early Access": [
39 "bespoke-vivr-fsi:read"
40 ]
41 }
42 ],
43 "parameters": [
44 {
45 "in": "query",
46 "name": "page",
47 "description": "The current page in the accounts collection",
48 "schema": {
49 "type": "integer",
50 "minimum": 1
51 }
52 },
53 {
54 "in": "query",
55 "name": "per_page",
56 "description": "The number of elements in the current page in accounts collection",
57 "schema": {
58 "type": "integer",
59 "minimum": 5,
60 "maximum": 100,
61 "default": 10
62 }
63 },
64 {
65 "in": "query",
66 "name": "number",
67 "description": "The account number to use in the search",
68 "required": false,
69 "schema": {
70 "type": "string"
71 }
72 },
73 {
74 "in": "query",
75 "name": "party",
76 "description": "The account signers name. The search returns any account with tied up to a party which name partially matches the criteria",
77 "required": false,
78 "schema": {
79 "type": "string"
80 }
81 }
82 ],
83 "responses": {
84 "200": {
85 "description": "The list of account details.",
86 "content": {
87 "application/hal+json": {
88 "schema": {
89 "type": "object",
90 "properties": {
91 "count": {
92 "description": "The number of items in the current page.",
93 "type": "integer"
94 },
95 "total": {
96 "description": "The total number of items.",
97 "type": "integer"
98 },
99 "page": {
100 "description": "Identify the current page",
101 "type": "integer",
102 "minimum": 1
103 },
104 "_links": {
105 "description": "HAL API related links.",
106 "type": "object",
107 "properties": {
108 "next": {
109 "description": "Link of the next page",
110 "type": "object",
111 "properties": {
112 "href": {
113 "description": "Address of the resource",
114 "type": "string"
115 }
116 }
117 },
118 "last": {
119 "description": "Link of the last page",
120 "type": "object",
121 "properties": {
122 "href": {
123 "description": "Address of the resource",
124 "type": "string"
125 }
126 }
127 },
128 "prev": {
129 "description": "Link of the previous page",
130 "type": "object",
131 "properties": {
132 "href": {
133 "description": "Address of the resource",
134 "type": "string"
135 }
136 }
137 },
138 "self": {
139 "description": "Link of the current page",
140 "type": "object",
141 "properties": {
142 "href": {
143 "description": "Address of the resource",
144 "type": "string"
145 }
146 }
147 },
148 "first": {
149 "description": "Link of the first page",
150 "type": "object",
151 "properties": {
152 "href": {
153 "description": "Address of the resource",
154 "type": "string"
155 }
156 }
157 }
158 },
159 "required": [
160 "self",
161 "next",
162 "prev",
163 "first",
164 "last"
165 ]
166 },
167 "_embedded": {
168 "type": "object",
169 "properties": {
170 "accounts": {
171 "description": "List of accounts",
172 "type": "array",
173 "items": {
174 "type": "object",
175 "required": [
176 "id",
177 "account_number",
178 "currency_code",
179 "iban",
180 "financial_institution_name",
181 "swift_code",
182 "account_name",
183 "account_type",
184 "parties",
185 "update_at",
186 "balances"
187 ],
188 "properties": {
189 "id": {
190 "type": "string",
191 "description": "Identification for an account"
192 },
193 "account_number": {
194 "type": "string",
195 "description": "Account number associated"
196 },
197 "currency_code": {
198 "type": "string",
199 "description": "Currency used in this account using ISO 4217 standard",
200 "minLength": 3,
201 "maxLength": 3
202 },
203 "iban": {
204 "type": "string",
205 "description": "IBAN number associated to this account",
206 "maxLength": 34
207 },
208 "financial_institution_name": {
209 "type": "string",
210 "description": "Financial institution name"
211 },
212 "swift_code": {
213 "type": "string",
214 "description": "SWIFT code associated to this account",
215 "minLength": 8,
216 "maxLength": 11
217 },
218 "account_name": {
219 "type": "string",
220 "description": "Name provided by the account owner"
221 },
222 "account_type": {
223 "type": "string",
224 "description": "Account type",
225 "enum": [
226 "UNDEFINED",
227 "CHECKING",
228 "SAVINGS",
229 "CREDIT_CARD"
230 ]
231 },
232 "parties": {
233 "description": "List of parties. A party is a person or company associated with the account.",
234 "type": "array",
235 "items": {
236 "type": "object",
237 "description": "Party identity information",
238 "properties": {
239 "person": {
240 "type": "object",
241 "required": [
242 "id",
243 "contact_id",
244 "name",
245 "contacts",
246 "addresses",
247 "id_document_number",
248 "id_document_type",
249 "birth_date"
250 ],
251 "properties": {
252 "id": {
253 "type": "string",
254 "description": "Identification for this contact at talkdesk system"
255 },
256 "contact_id": {
257 "type": "string",
258 "description": "The contact id from the extenal institution"
259 },
260 "name": {
261 "type": "string",
262 "description": "Contact name"
263 },
264 "contacts": {
265 "type": "array",
266 "items": {
267 "type": "object",
268 "required": [
269 "id",
270 "type",
271 "value",
272 "use",
273 "rank"
274 ],
275 "properties": {
276 "id": {
277 "type": "string",
278 "description": "Identification for contact point"
279 },
280 "type": {
281 "type": "string",
282 "description": "Define the type for this contact point",
283 "enum": [
284 "PHONE",
285 "EMAIL",
286 "SMS",
287 "OTHER"
288 ]
289 },
290 "value": {
291 "type": "string",
292 "description": "The actual contact point details"
293 },
294 "use": {
295 "type": "string",
296 "description": "Purpose of this contact point",
297 "enum": [
298 "HOME",
299 "WORK",
300 "MOBILE",
301 "TEMPORARY",
302 "OLD"
303 ]
304 },
305 "rank": {
306 "description": "Specify preferred order of use (1 = highest)",
307 "type": "integer",
308 "minimum": 1
309 }
310 }
311 }
312 },
313 "addresses": {
314 "type": "array",
315 "items": {
316 "properties": {
317 "id": {
318 "type": "string",
319 "description": "Identification for the address"
320 },
321 "address_type": {
322 "type": "string",
323 "description": "Address type",
324 "enum": [
325 "POSTAL",
326 "PHYSICAL",
327 "BOTH"
328 ]
329 },
330 "street": {
331 "type": "string",
332 "description": "Street name address (can be Street, Avenue, Square, etc.)"
333 },
334 "city": {
335 "type": "string",
336 "description": "Name of city, town etc."
337 },
338 "district": {
339 "type": "string",
340 "description": "District name (aka county)"
341 },
342 "state": {
343 "type": "string",
344 "description": "Sub-unit of country (abbreviations ok)"
345 },
346 "postal_code": {
347 "type": "string"
348 },
349 "country": {
350 "type": "string",
351 "description": "Country (e.g. can be ISO 3166 2 or 3 letter code)"
352 }
353 }
354 }
355 },
356 "id_document_number": {
357 "type": "string",
358 "description": "Document number associated to a person"
359 },
360 "id_document_type": {
361 "type": "string",
362 "enum": [
363 "SOCIAL_SECURITY",
364 "DRIVER_LICENSE",
365 "PASSPORT",
366 "NATIONAL_ID",
367 "OTHER"
368 ]
369 },
370 "birth_date": {
371 "type": "string",
372 "format": "date"
373 },
374 "_links": {
375 "description": "Self link item for HAL",
376 "properties": {
377 "self": {
378 "description": "Link of the current page",
379 "type": "object",
380 "properties": {
381 "href": {
382 "description": "Address of the resource",
383 "type": "string"
384 }
385 }
386 }
387 },
388 "required": [
389 "self"
390 ],
391 "type": "object"
392 }
393 }
394 },
395 "role": {
396 "type": "string",
397 "description": "Type of role associated with a party member",
398 "enum": [
399 "HOLDER",
400 "AUTHORIZED_PARTY",
401 "OTHER",
402 "UNKNOWN"
403 ]
404 }
405 }
406 },
407 "minItems": 1
408 },
409 "update_at": {
410 "type": "string",
411 "format": "date-time"
412 },
413 "balances": {
414 "type": "array",
415 "items": {
416 "type": "object",
417 "description": "Amount of value in an account for a specific momento",
418 "properties": {
419 "update_at": {
420 "type": "string",
421 "format": "date-time"
422 },
423 "type": {
424 "type": "string",
425 "enum": [
426 "AVAILABLE",
427 "BOOKED"
428 ]
429 },
430 "value": {
431 "type": "object",
432 "description": "A tuple with value and currency",
433 "properties": {
434 "value": {
435 "type": "number",
436 "description": "A value associated with a currency"
437 },
438 "currency": {
439 "type": "string",
440 "description": "Use currency code ISO 4217",
441 "minLength": 3,
442 "maxLength": 3
443 }
444 }
445 }
446 }
447 }
448 },
449 "_links": {
450 "description": "Self link item for HAL",
451 "properties": {
452 "self": {
453 "description": "Link of the current page",
454 "type": "object",
455 "properties": {
456 "href": {
457 "description": "Address of the resource",
458 "type": "string"
459 }
460 }
461 }
462 },
463 "required": [
464 "self"
465 ],
466 "type": "object"
467 }
468 }
469 }
470 }
471 }
472 }
473 }
474 },
475 "example": {
476 "count": 5,
477 "total": 40,
478 "page": 4,
479 "_links": {
480 "next": {
481 "href": "http://localhost:8081/fsi/accounts?page=5,per_page=5"
482 },
483 "last": {
484 "href": "http://localhost:8081/fsi/accounts?page=8,per_page=5"
485 },
486 "self": {
487 "href": "http://localhost:8081/fsi/accounts?page4,per_page=5"
488 },
489 "prev": {
490 "href": "http://localhost:8081/fsi/accounts?page=3,per_page=5"
491 },
492 "first": {
493 "href": "http://localhost:8081/fsi/accounts?page=1,per_page=5"
494 }
495 },
496 "_embedded": {
497 "accounts": [
498 {
499 "id": "account_id_1234546",
500 "account_number": "1234-124-1",
501 "currency_code": "EUR",
502 "iban": "LU280019400644750000",
503 "financial_institution_name": "King Julian Bank",
504 "swift_code": "KIJBLULU",
505 "account_name": "My Personal Account",
506 "account_type": "CHECKING",
507 "parties": [
508 {
509 "person": {
510 "id": "0120343",
511 "contact_id": "AC12334543",
512 "name": "John Doe",
513 "contacts": [
514 {
515 "id": "Personal Number",
516 "type": "PHONE",
517 "value": "1235 42352",
518 "use": "HOME",
519 "rank": 1
520 }
521 ],
522 "addresses": [
523 {
524 "id": "My home",
525 "address_type": "PHYSICAL",
526 "street": "1600 Pennsylvania Avenue NW",
527 "city": "Washington",
528 "district": "D.C.",
529 "state": "D.C.",
530 "postal_code": "DC 20500",
531 "country": "USA"
532 },
533 {
534 "id": "Office Address",
535 "address_type": "POSTAL",
536 "street": "Rua Campo Grande, 25",
537 "city": "Lisbon",
538 "district": "Lisbon",
539 "state": "LI",
540 "postal_code": "1600-036",
541 "country": "PRT"
542 }
543 ],
544 "id_document_number": "AB123456",
545 "id_document_type": "PASSPORT",
546 "birth_date": "1974-12-14",
547 "_links": {
548 "self": {
549 "href": "http://localhost:8081/fsi/contacts/0120343"
550 }
551 }
552 },
553 "role": "HOLDER"
554 }
555 ],
556 "update_at": "2021-04-13T16:44:49.029Z",
557 "balances": [
558 {
559 "update_at": "2021-04-13T16:44:49.029Z",
560 "type": "AVAILABLE",
561 "value": {
562 "value": 257.87,
563 "currency": "EUR"
564 }
565 },
566 {
567 "update_at": "2021-04-13T18:44:49.029Z",
568 "type": "BOOKED",
569 "value": {
570 "value": 10234.87,
571 "currency": "GBP"
572 }
573 }
574 ],
575 "_links": {
576 "self": {
577 "href": "http://localhost:8081/fsi/accounts/account_id_1234546"
578 }
579 }
580 },
581 {
582 "id": "account_id_1234547",
583 "account_number": "1234-1",
584 "currency_code": "EUR",
585 "iban": "LU280019400644758787",
586 "financial_institution_name": "King Julian Bank",
587 "swift_code": "KIJBLULU",
588 "account_name": "Other Personal Account",
589 "account_type": "SAVINGS",
590 "parties": [
591 {
592 "person": {
593 "id": "0120343",
594 "contact_id": "AC12334543",
595 "name": "Mary Whom",
596 "contacts": [
597 {
598 "id": "Personal Number",
599 "type": "PHONE",
600 "value": "98765 42352",
601 "use": "HOME",
602 "rank": 2
603 }
604 ],
605 "addresses": [
606 {
607 "id": "Office Address",
608 "address_type": "POSTAL",
609 "street": "Rua Campo Grande, 85",
610 "city": "Lisbon",
611 "district": "Lisbon",
612 "state": "LI",
613 "postal_code": "1600-036",
614 "country": "PRT"
615 }
616 ],
617 "id_document_number": "AB654321",
618 "id_document_type": "PASSPORT",
619 "birth_date": "1978-12-01",
620 "_links": {
621 "self": {
622 "href": "http://localhost:8081/fsi/contacts/0120343"
623 }
624 }
625 },
626 "role": "HOLDER"
627 }
628 ],
629 "update_at": "2021-02-13T16:44:49.029Z",
630 "balances": [
631 {
632 "update_at": "2021-03-13T16:44:49.029Z",
633 "type": "AVAILABLE",
634 "value": {
635 "value": 1257.87,
636 "currency": "USD"
637 }
638 }
639 ],
640 "_links": {
641 "self": {
642 "href": "http://localhost:8081/fsi/accounts/account_id_1234547"
643 }
644 }
645 }
646 ]
647 }
648 }
649 }
650 }
651 },
652 "400": {
653 "description": "Bad Request",
654 "content": {
655 "application/json": {
656 "schema": {
657 "type": "object",
658 "required": [
659 "code",
660 "message"
661 ],
662 "properties": {
663 "code": {
664 "type": "string"
665 },
666 "message": {
667 "type": "string"
668 },
669 "description": {
670 "type": "string"
671 },
672 "fields": {
673 "type": "array",
674 "items": {
675 "type": "object",
676 "properties": {
677 "name": {
678 "type": "string"
679 },
680 "description": {
681 "type": "string"
682 }
683 }
684 }
685 }
686 }
687 },
688 "example": {
689 "code": "1500000",
690 "message": "Bad request."
691 }
692 }
693 }
694 },
695 "401": {
696 "description": "Unauthorized",
697 "content": {
698 "application/json": {
699 "schema": {
700 "type": "object",
701 "required": [
702 "code",
703 "message"
704 ],
705 "properties": {
706 "code": {
707 "type": "string"
708 },
709 "message": {
710 "type": "string"
711 },
712 "description": {
713 "type": "string"
714 },
715 "fields": {
716 "type": "array",
717 "items": {
718 "type": "object",
719 "properties": {
720 "name": {
721 "type": "string"
722 },
723 "description": {
724 "type": "string"
725 }
726 }
727 }
728 }
729 }
730 },
731 "example": {
732 "code": "1500001",
733 "message": "Invalid JWT."
734 }
735 }
736 }
737 },
738 "403": {
739 "description": "Forbidden",
740 "content": {
741 "application/json": {
742 "schema": {
743 "type": "object",
744 "required": [
745 "code",
746 "message"
747 ],
748 "properties": {
749 "code": {
750 "type": "string"
751 },
752 "message": {
753 "type": "string"
754 },
755 "description": {
756 "type": "string"
757 },
758 "fields": {
759 "type": "array",
760 "items": {
761 "type": "object",
762 "properties": {
763 "name": {
764 "type": "string"
765 },
766 "description": {
767 "type": "string"
768 }
769 }
770 }
771 }
772 }
773 },
774 "example": {
775 "code": "1500002",
776 "message": "Required scopes are missing."
777 }
778 }
779 }
780 }
781 }
782 }
783 },
784 "/bespoke/visual-ivr/fsi/cards": {
785 "get": {
786 "tags": [
787 "Visual IVR FSI Cards"
788 ],
789 "summary": "Get all cards from a specific contact",
790 "security": [
791 {
792 "Early Access": [
793 "bespoke-vivr-fsi:read"
794 ]
795 }
796 ],
797 "parameters": [
798 {
799 "in": "query",
800 "name": "page",
801 "description": "The current page in the cards collection",
802 "schema": {
803 "type": "integer",
804 "minimum": 1
805 }
806 },
807 {
808 "in": "query",
809 "name": "per_page",
810 "description": "The number of elements in the current page in cards collection",
811 "schema": {
812 "type": "integer",
813 "minimum": 1,
814 "maximum": 10,
815 "default": 5
816 }
817 }
818 ],
819 "responses": {
820 "200": {
821 "description": "The list of cards",
822 "content": {
823 "application/hal+json": {
824 "schema": {
825 "type": "object",
826 "properties": {
827 "count": {
828 "description": "The number of items in the current page",
829 "type": "integer"
830 },
831 "total": {
832 "description": "The total number of items",
833 "type": "integer"
834 },
835 "page": {
836 "description": "Identify the current page",
837 "type": "integer",
838 "minimum": 1
839 },
840 "_links": {
841 "description": "HAL API related links",
842 "type": "object",
843 "properties": {
844 "next": {
845 "description": "Link of the next page",
846 "type": "object",
847 "properties": {
848 "href": {
849 "description": "Address of the resource",
850 "type": "string"
851 }
852 }
853 },
854 "last": {
855 "description": "Link of the last page",
856 "type": "object",
857 "properties": {
858 "href": {
859 "description": "Address of the resource",
860 "type": "string"
861 }
862 }
863 },
864 "prev": {
865 "description": "Link of the previous page",
866 "type": "object",
867 "properties": {
868 "href": {
869 "description": "Address of the resource",
870 "type": "string"
871 }
872 }
873 },
874 "self": {
875 "description": "Link of the current page",
876 "type": "object",
877 "properties": {
878 "href": {
879 "description": "Address of the resource",
880 "type": "string"
881 }
882 }
883 },
884 "first": {
885 "description": "Link of the first page",
886 "type": "object",
887 "properties": {
888 "href": {
889 "description": "Address of the resource",
890 "type": "string"
891 }
892 }
893 }
894 },
895 "required": [
896 "self",
897 "next",
898 "prev",
899 "first",
900 "last"
901 ]
902 },
903 "_embedded": {
904 "type": "object",
905 "properties": {
906 "cards": {
907 "description": "List of cards",
908 "type": "array",
909 "items": {
910 "type": "object",
911 "required": [
912 "id",
913 "card_number",
914 "card_type",
915 "activation_at",
916 "expiration_at",
917 "holder_type",
918 "emboss_name",
919 "product_name",
920 "primary_card_id",
921 "payment_due_at",
922 "minimum_due_amount",
923 "outstanding_balance",
924 "available_credit_limit",
925 "card_status"
926 ],
927 "properties": {
928 "id": {
929 "type": "string",
930 "description": "Identification for a card"
931 },
932 "card_number": {
933 "type": "string",
934 "description": "A masked card number that can be displayed to the customer.",
935 "example": "XXXXXXXXXXXX4521",
936 "minLength": 16,
937 "maxLength": 16
938 },
939 "card_type": {
940 "type": "string",
941 "description": "Inform the card type",
942 "enum": [
943 "DEBIT",
944 "CREDIT"
945 ]
946 },
947 "activation_at": {
948 "type": "string",
949 "description": "When the card is activated by the holder",
950 "format": "date"
951 },
952 "expiration_at": {
953 "type": "string",
954 "description": "Card expiration date",
955 "format": "date"
956 },
957 "holder_type": {
958 "type": "string",
959 "description": "Define if the card holder is the owner or the dependent",
960 "enum": [
961 "PRIMARY",
962 "COMPLEMENTARY"
963 ]
964 },
965 "emboss_name": {
966 "type": "string",
967 "description": "The name printed in the card.",
968 "maxLength": 30
969 },
970 "product_name": {
971 "type": "string",
972 "description": "Bank card product name",
973 "example": "TD Bank Visa Gold"
974 },
975 "primary_card_id": {
976 "type": "string",
977 "description": "If hoder_type is complementary this provides access to the primary card, otherwise returns an empty string"
978 },
979 "payment_due_at": {
980 "type": "string",
981 "description": "Month date to pay the card",
982 "format": "date"
983 },
984 "minimum_due_amount": {
985 "type": "object",
986 "description": "A tuple with value and currency",
987 "properties": {
988 "value": {
989 "type": "number",
990 "description": "A value associated with a currency"
991 },
992 "currency": {
993 "type": "string",
994 "description": "Use currency code ISO 4217",
995 "minLength": 3,
996 "maxLength": 3
997 }
998 }
999 },
1000 "outstanding_balance": {
1001 "type": "object",
1002 "description": "A tuple with value and currency",
1003 "properties": {
1004 "value": {
1005 "type": "number",
1006 "description": "A value associated with a currency"
1007 },
1008 "currency": {
1009 "type": "string",
1010 "description": "Use currency code ISO 4217",
1011 "minLength": 3,
1012 "maxLength": 3
1013 }
1014 }
1015 },
1016 "available_credit_limit": {
1017 "type": "object",
1018 "description": "A tuple with value and currency",
1019 "properties": {
1020 "value": {
1021 "type": "number",
1022 "description": "A value associated with a currency"
1023 },
1024 "currency": {
1025 "type": "string",
1026 "description": "Use currency code ISO 4217",
1027 "minLength": 3,
1028 "maxLength": 3
1029 }
1030 }
1031 },
1032 "card_status": {
1033 "type": "string",
1034 "description": "Describe the current status for the card",
1035 "enum": [
1036 "ACTIVE",
1037 "CLOSED",
1038 "INACTIVE"
1039 ]
1040 }
1041 }
1042 }
1043 }
1044 }
1045 }
1046 }
1047 },
1048 "example": {
1049 "count": 2,
1050 "total": 10,
1051 "page": 3,
1052 "_links": {
1053 "next": {
1054 "href": "http://localhost:8081/fsi/cards/1234dsf234/transactions?page=4,per_page=2"
1055 },
1056 "last": {
1057 "href": "http://localhost:8081/fsi/cards/1234dsf234/transactions?page=5,per_page=2"
1058 },
1059 "self": {
1060 "href": "http://localhost:8081/fsi/cards/1234dsf234/transactions?page=3,per_page=2"
1061 },
1062 "prev": {
1063 "href": "http://localhost:8081/fsi/cards/1234dsf234/transactions?page=2,per_page=2"
1064 },
1065 "first": {
1066 "href": "http://localhost:8081/fsi/cards/1234dsf234/transactions?page=1,per_page=2"
1067 }
1068 },
1069 "_embedded": {
1070 "cards": [
1071 {
1072 "id": "card_td_id_123456",
1073 "card_number": "XXXXXXXXXXXX4521",
1074 "card_type": "DEBIT",
1075 "activation_at": "2018-02-21",
1076 "expiration_at": "2022-06-12",
1077 "holder_type": "PRIMARY",
1078 "emboss_name": "KING JULIAN",
1079 "product_name": "TD Bank Visa Gold",
1080 "primary_card_id": "",
1081 "payment_due_at": "2021-04-26",
1082 "minimum_due_amount": {
1083 "value": 250.1,
1084 "currency": "EUR"
1085 },
1086 "outstanding_balance": {
1087 "value": 254.02,
1088 "currency": "EUR"
1089 },
1090 "available_credit_limit": {
1091 "value": 0,
1092 "currency": "EUR"
1093 },
1094 "card_status": "ACTIVE"
1095 },
1096 {
1097 "id": "card_td_id_123457",
1098 "card_number": "XXXXXXXXXXXX4243",
1099 "card_type": "CREDIT",
1100 "activation_at": "2018-02-21",
1101 "expiration_at": "2022-06-12",
1102 "holder_type": "COMPLEMENTARY",
1103 "emboss_name": "MAURICE JULIAN",
1104 "product_name": "TD Bank MasterCard Platinum",
1105 "primary_card_id": "card_td_id_123456",
1106 "payment_due_at": "2021-04-26",
1107 "minimum_due_amount": {
1108 "value": 250.1,
1109 "currency": "EUR"
1110 },
1111 "outstanding_balance": {
1112 "value": 254.02,
1113 "currency": "EUR"
1114 },
1115 "available_credit_limit": {
1116 "value": 45000,
1117 "currency": "EUR"
1118 },
1119 "card_status": "INACTIVE"
1120 }
1121 ]
1122 }
1123 }
1124 }
1125 }
1126 },
1127 "400": {
1128 "description": "Bad Request",
1129 "content": {
1130 "application/json": {
1131 "schema": {
1132 "type": "object",
1133 "required": [
1134 "code",
1135 "message"
1136 ],
1137 "properties": {
1138 "code": {
1139 "type": "string"
1140 },
1141 "message": {
1142 "type": "string"
1143 },
1144 "description": {
1145 "type": "string"
1146 },
1147 "fields": {
1148 "type": "array",
1149 "items": {
1150 "type": "object",
1151 "properties": {
1152 "name": {
1153 "type": "string"
1154 },
1155 "description": {
1156 "type": "string"
1157 }
1158 }
1159 }
1160 }
1161 }
1162 },
1163 "example": {
1164 "code": "1500000",
1165 "message": "Bad request."
1166 }
1167 }
1168 }
1169 },
1170 "401": {
1171 "description": "Unauthorized",
1172 "content": {
1173 "application/json": {
1174 "schema": {
1175 "type": "object",
1176 "required": [
1177 "code",
1178 "message"
1179 ],
1180 "properties": {
1181 "code": {
1182 "type": "string"
1183 },
1184 "message": {
1185 "type": "string"
1186 },
1187 "description": {
1188 "type": "string"
1189 },
1190 "fields": {
1191 "type": "array",
1192 "items": {
1193 "type": "object",
1194 "properties": {
1195 "name": {
1196 "type": "string"
1197 },
1198 "description": {
1199 "type": "string"
1200 }
1201 }
1202 }
1203 }
1204 }
1205 },
1206 "example": {
1207 "code": "1500001",
1208 "message": "Invalid JWT."
1209 }
1210 }
1211 }
1212 },
1213 "403": {
1214 "description": "Forbidden",
1215 "content": {
1216 "application/json": {
1217 "schema": {
1218 "type": "object",
1219 "required": [
1220 "code",
1221 "message"
1222 ],
1223 "properties": {
1224 "code": {
1225 "type": "string"
1226 },
1227 "message": {
1228 "type": "string"
1229 },
1230 "description": {
1231 "type": "string"
1232 },
1233 "fields": {
1234 "type": "array",
1235 "items": {
1236 "type": "object",
1237 "properties": {
1238 "name": {
1239 "type": "string"
1240 },
1241 "description": {
1242 "type": "string"
1243 }
1244 }
1245 }
1246 }
1247 }
1248 },
1249 "example": {
1250 "code": "1500002",
1251 "message": "Required scopes are missing."
1252 }
1253 }
1254 }
1255 }
1256 }
1257 }
1258 },
1259 "/bespoke/visual-ivr/fsi/events": {
1260 "post": {
1261 "tags": [
1262 "Visual IVR FSI Events"
1263 ],
1264 "summary": "Obtain the events that occurs in a session",
1265 "security": [
1266 {
1267 "Early Access": [
1268 "bespoke-vivr-fsi:write"
1269 ]
1270 }
1271 ],
1272 "requestBody": {
1273 "required": true,
1274 "content": {
1275 "application/json": {
1276 "schema": {
1277 "type": "object",
1278 "required": [
1279 "event"
1280 ],
1281 "properties": {
1282 "event": {
1283 "type": "object",
1284 "description": "Define an event during a session in Visual IVR",
1285 "required": [
1286 "id",
1287 "type",
1288 "timestamp"
1289 ],
1290 "properties": {
1291 "id": {
1292 "type": "string",
1293 "description": "Unique session ID in use"
1294 },
1295 "type": {
1296 "type": "string",
1297 "description": "Define the event type",
1298 "enum": [
1299 "SMS_SENT",
1300 "SESSION_START",
1301 "ACTION_EXECUTED"
1302 ]
1303 },
1304 "timestamp": {
1305 "type": "string",
1306 "description": "Timestamp formated in ISO8601 UTC",
1307 "format": "date-time"
1308 }
1309 }
1310 },
1311 "action": {
1312 "type": "object",
1313 "description": "Define an action that occurs in an event",
1314 "required": [
1315 "type",
1316 "status"
1317 ],
1318 "properties": {
1319 "type": {
1320 "type": "string",
1321 "description": "Define the type of action",
1322 "enum": [
1323 "LIST_ACCOUNTS",
1324 "LIST_TRANSACTIONS",
1325 "LIST_PAYMENTS",
1326 "LIST_CARDS",
1327 "ACTIVATE_CARD",
1328 "DEACTIVATE_CARD"
1329 ]
1330 },
1331 "status": {
1332 "type": "string",
1333 "description": "Indicate if the Visual IVR was able to show the information requested",
1334 "enum": [
1335 "OK",
1336 "ERROR"
1337 ]
1338 },
1339 "data": {
1340 "type": "array",
1341 "description": "List of information regarding an event",
1342 "items": {
1343 "type": "object"
1344 }
1345 }
1346 }
1347 }
1348 }
1349 },
1350 "examples": {
1351 "Event `SMS Sent`": {
1352 "value": {
1353 "event": {
1354 "id": "UNIQUE_ID",
1355 "type": "SMS_SENT",
1356 "timestamp": "2021-04-23T18:25:43.511Z"
1357 }
1358 }
1359 },
1360 "Event `Session Start`": {
1361 "value": {
1362 "event": {
1363 "id": "UNIQUE_ID",
1364 "type": "SESSION_START",
1365 "timestamp": "2021-04-23T18:25:43.511Z"
1366 }
1367 }
1368 },
1369 "Event `Action Executed` - List Accounts": {
1370 "value": {
1371 "event": {
1372 "id": "UNIQUE_ID",
1373 "type": "ACTION_EXECUTED",
1374 "timestamp": "2021-04-23T18:25:43.511Z"
1375 },
1376 "action": {
1377 "type": "LIST_ACCOUNTS",
1378 "status": "OK"
1379 }
1380 }
1381 },
1382 "Event `Action Executed` - List Transactions": {
1383 "value": {
1384 "event": {
1385 "id": "UNIQUE_ID",
1386 "type": "ACTION_EXECUTED",
1387 "timestamp": "2021-04-23T18:25:43.511Z"
1388 },
1389 "action": {
1390 "type": "LIST_ACCOUNTS",
1391 "status": "OK",
1392 "data": [
1393 {
1394 "account_id": "ACCOUNT ID"
1395 }
1396 ]
1397 }
1398 }
1399 },
1400 "Event `Action Executed` - List Payments": {
1401 "value": {
1402 "event": {
1403 "id": "UNIQUE_ID",
1404 "type": "ACTION_EXECUTED",
1405 "timestamp": "2021-04-23T18:25:43.511Z"
1406 },
1407 "action": {
1408 "type": "LIST_PAYMENTS",
1409 "status": "OK",
1410 "data": [
1411 {
1412 "account_id": "ACCOUNT ID"
1413 }
1414 ]
1415 }
1416 }
1417 },
1418 "Event `Action Executed` - List Cards": {
1419 "value": {
1420 "event": {
1421 "id": "UNIQUE_ID",
1422 "type": "ACTION_EXECUTED",
1423 "timestamp": "2021-04-23T18:25:43.511Z"
1424 },
1425 "action": {
1426 "type": "LIST_CARDS",
1427 "status": "OK"
1428 }
1429 }
1430 },
1431 "Event `Action Executed` - Activate card": {
1432 "value": {
1433 "event": {
1434 "id": "UNIQUE_ID",
1435 "type": "ACTION_EXECUTED",
1436 "timestamp": "2021-04-23T18:25:43.511Z"
1437 },
1438 "action": {
1439 "type": "ACTIVATE_CARD",
1440 "status": "OK",
1441 "data": [
1442 {
1443 "card_id": "ACCOUNT ID"
1444 }
1445 ]
1446 }
1447 }
1448 },
1449 "Event `Action Executed` - Deactivate card": {
1450 "value": {
1451 "event": {
1452 "id": "UNIQUE_ID",
1453 "type": "ACTION_EXECUTED",
1454 "timestamp": "2021-04-23T18:25:43.511Z"
1455 },
1456 "action": {
1457 "type": "DEACTIVATE_CARD",
1458 "status": "OK",
1459 "data": [
1460 {
1461 "card_id": "ACCOUNT ID"
1462 }
1463 ]
1464 }
1465 }
1466 }
1467 }
1468 }
1469 }
1470 },
1471 "responses": {
1472 "201": {
1473 "description": "Created"
1474 },
1475 "401": {
1476 "description": "Unauthorized",
1477 "content": {
1478 "application/json": {
1479 "schema": {
1480 "type": "object",
1481 "required": [
1482 "code",
1483 "message"
1484 ],
1485 "properties": {
1486 "code": {
1487 "type": "string"
1488 },
1489 "message": {
1490 "type": "string"
1491 },
1492 "description": {
1493 "type": "string"
1494 },
1495 "fields": {
1496 "type": "array",
1497 "items": {
1498 "type": "object",
1499 "properties": {
1500 "name": {
1501 "type": "string"
1502 },
1503 "description": {
1504 "type": "string"
1505 }
1506 }
1507 }
1508 }
1509 }
1510 },
1511 "example": {
1512 "code": "1500001",
1513 "message": "Invalid JWT."
1514 }
1515 }
1516 }
1517 },
1518 "403": {
1519 "description": "Forbidden",
1520 "content": {
1521 "application/json": {
1522 "schema": {
1523 "type": "object",
1524 "required": [
1525 "code",
1526 "message"
1527 ],
1528 "properties": {
1529 "code": {
1530 "type": "string"
1531 },
1532 "message": {
1533 "type": "string"
1534 },
1535 "description": {
1536 "type": "string"
1537 },
1538 "fields": {
1539 "type": "array",
1540 "items": {
1541 "type": "object",
1542 "properties": {
1543 "name": {
1544 "type": "string"
1545 },
1546 "description": {
1547 "type": "string"
1548 }
1549 }
1550 }
1551 }
1552 }
1553 },
1554 "example": {
1555 "code": "1500002",
1556 "message": "Required scopes are missing."
1557 }
1558 }
1559 }
1560 },
1561 "404": {
1562 "description": "Not Found",
1563 "content": {
1564 "application/json": {
1565 "schema": {
1566 "type": "object",
1567 "required": [
1568 "code",
1569 "message"
1570 ],
1571 "properties": {
1572 "code": {
1573 "type": "string"
1574 },
1575 "message": {
1576 "type": "string"
1577 },
1578 "description": {
1579 "type": "string"
1580 },
1581 "fields": {
1582 "type": "array",
1583 "items": {
1584 "type": "object",
1585 "properties": {
1586 "name": {
1587 "type": "string"
1588 },
1589 "description": {
1590 "type": "string"
1591 }
1592 }
1593 }
1594 }
1595 }
1596 },
1597 "example": {
1598 "code": "1500003",
1599 "message": "Resource not found."
1600 }
1601 }
1602 }
1603 }
1604 }
1605 }
1606 },
1607 "/bespoke/visual-ivr/fsi/accounts/{account_id}/transactions": {
1608 "get": {
1609 "tags": [
1610 "Visual IVR FSI Transactions"
1611 ],
1612 "summary": "Get a list of transactions from a specific account",
1613 "security": [
1614 {
1615 "Early Access": [
1616 "bespoke-vivr-fsi:read"
1617 ]
1618 }
1619 ],
1620 "parameters": [
1621 {
1622 "in": "path",
1623 "name": "account_id",
1624 "schema": {
1625 "type": "string"
1626 },
1627 "required": true,
1628 "description": "The account id"
1629 },
1630 {
1631 "in": "query",
1632 "name": "per_page",
1633 "schema": {
1634 "type": "integer",
1635 "minimum": 10,
1636 "maximum": 50,
1637 "default": 20
1638 }
1639 },
1640 {
1641 "in": "query",
1642 "name": "page",
1643 "description": "The current page in the transactions collection",
1644 "schema": {
1645 "type": "integer",
1646 "minimum": 1
1647 }
1648 }
1649 ],
1650 "responses": {
1651 "200": {
1652 "description": "The list of transactions.",
1653 "content": {
1654 "application/hal+json": {
1655 "schema": {
1656 "type": "object",
1657 "properties": {
1658 "count": {
1659 "description": "The number of items in the current page",
1660 "type": "integer"
1661 },
1662 "total": {
1663 "description": "The total number of items",
1664 "type": "integer"
1665 },
1666 "page": {
1667 "description": "Identify the current page",
1668 "type": "integer",
1669 "minimum": 1
1670 },
1671 "_links": {
1672 "description": "HAL API related links",
1673 "type": "object",
1674 "properties": {
1675 "next": {
1676 "description": "Link of the next page",
1677 "type": "object",
1678 "properties": {
1679 "href": {
1680 "description": "Address of the resource",
1681 "type": "string"
1682 }
1683 }
1684 },
1685 "last": {
1686 "description": "Link of the last page",
1687 "type": "object",
1688 "properties": {
1689 "href": {
1690 "description": "Address of the resource",
1691 "type": "string"
1692 }
1693 }
1694 },
1695 "prev": {
1696 "description": "Link of the previous page",
1697 "type": "object",
1698 "properties": {
1699 "href": {
1700 "description": "Address of the resource",
1701 "type": "string"
1702 }
1703 }
1704 },
1705 "self": {
1706 "description": "Link of the current page",
1707 "type": "object",
1708 "properties": {
1709 "href": {
1710 "description": "Address of the resource",
1711 "type": "string"
1712 }
1713 }
1714 },
1715 "first": {
1716 "description": "Link of the first page",
1717 "type": "object",
1718 "properties": {
1719 "href": {
1720 "description": "Address of the resource",
1721 "type": "string"
1722 }
1723 }
1724 }
1725 },
1726 "required": [
1727 "self",
1728 "next",
1729 "prev",
1730 "first",
1731 "last"
1732 ]
1733 },
1734 "_embedded": {
1735 "type": "object",
1736 "properties": {
1737 "transactions": {
1738 "description": "List of transactions list in an account",
1739 "type": "array",
1740 "items": {
1741 "type": "object",
1742 "required": [
1743 "id",
1744 "transaction_id",
1745 "description",
1746 "value",
1747 "booked_at",
1748 "value_at",
1749 "status",
1750 "type"
1751 ],
1752 "properties": {
1753 "id": {
1754 "type": "string",
1755 "description": "Identification for a single transaction"
1756 },
1757 "transaction_id": {
1758 "type": "string",
1759 "description": "Transaction id provide by a external resource"
1760 },
1761 "description": {
1762 "type": "string",
1763 "description": "Brief description for a transaction"
1764 },
1765 "value": {
1766 "type": "object",
1767 "description": "A tuple with value and currency",
1768 "properties": {
1769 "value": {
1770 "type": "number",
1771 "description": "A value associated with a currency"
1772 },
1773 "currency": {
1774 "type": "string",
1775 "description": "Use currency code ISO 4217",
1776 "minLength": 3,
1777 "maxLength": 3
1778 }
1779 }
1780 },
1781 "booked_at": {
1782 "type": "string",
1783 "format": "date",
1784 "description": "Book date in this transaction"
1785 },
1786 "value_at": {
1787 "type": "string",
1788 "format": "date",
1789 "description": "Valua in a specific date"
1790 },
1791 "status": {
1792 "type": "string",
1793 "enum": [
1794 "BOOKED",
1795 "PENDING",
1796 "UNDEFINED"
1797 ]
1798 },
1799 "type": {
1800 "type": "string",
1801 "enum": [
1802 "UNDEFINED",
1803 "CREDIT_CARD",
1804 "PAYMENT",
1805 "WITHDRAWAL",
1806 "DEFAULT",
1807 "TRANSFER"
1808 ]
1809 }
1810 }
1811 }
1812 }
1813 }
1814 }
1815 }
1816 },
1817 "example": {
1818 "count": 5,
1819 "total": 40,
1820 "page": 2,
1821 "_links": {
1822 "next": {
1823 "href": "http://localhost:8081/fsi/accounts/123786182/transactions?page=3,per_page=5"
1824 },
1825 "last": {
1826 "href": "http://localhost:8081/fsi/accounts/123786182/transactions?page=8,per_page=5"
1827 },
1828 "self": {
1829 "href": "http://localhost:8081/fsi/accounts/123786182/transactions?page=2,per_page=5"
1830 },
1831 "prev": {
1832 "href": "http://localhost:8081/fsi/accounts/123786182/transactions?page=1,per_page=5"
1833 },
1834 "first": {
1835 "href": "http://localhost:8081/fsi/accounts/123786182/transactions?page=1,per_page=5"
1836 }
1837 },
1838 "_embedded": {
1839 "transactions": [
1840 {
1841 "id": "123456",
1842 "transaction_id": "ACTV_ID_TRANS_123456",
1843 "description": "TD Salary",
1844 "value": {
1845 "value": 87.54,
1846 "currency": "BRL"
1847 },
1848 "booked_at": "2021-02-12",
1849 "value_at": "2021-04-14",
1850 "status": "BOOKED",
1851 "type": "PAYMENT"
1852 },
1853 {
1854 "id": "123457",
1855 "transaction_id": "ATM_ID_TRANS_123456",
1856 "description": "Withdrawal - ATM Saint John St",
1857 "value": {
1858 "value": 100,
1859 "currency": "EUR"
1860 },
1861 "booked_at": "2021-03-13",
1862 "value_at": "2021-03-13",
1863 "status": "PENDING",
1864 "type": "WITHDRAWAL"
1865 }
1866 ]
1867 }
1868 }
1869 }
1870 }
1871 },
1872 "400": {
1873 "description": "Bad Request",
1874 "content": {
1875 "application/json": {
1876 "schema": {
1877 "type": "object",
1878 "required": [
1879 "code",
1880 "message"
1881 ],
1882 "properties": {
1883 "code": {
1884 "type": "string"
1885 },
1886 "message": {
1887 "type": "string"
1888 },
1889 "description": {
1890 "type": "string"
1891 },
1892 "fields": {
1893 "type": "array",
1894 "items": {
1895 "type": "object",
1896 "properties": {
1897 "name": {
1898 "type": "string"
1899 },
1900 "description": {
1901 "type": "string"
1902 }
1903 }
1904 }
1905 }
1906 }
1907 },
1908 "example": {
1909 "code": "1500000",
1910 "message": "Bad request."
1911 }
1912 }
1913 }
1914 },
1915 "401": {
1916 "description": "Unauthorized",
1917 "content": {
1918 "application/json": {
1919 "schema": {
1920 "type": "object",
1921 "required": [
1922 "code",
1923 "message"
1924 ],
1925 "properties": {
1926 "code": {
1927 "type": "string"
1928 },
1929 "message": {
1930 "type": "string"
1931 },
1932 "description": {
1933 "type": "string"
1934 },
1935 "fields": {
1936 "type": "array",
1937 "items": {
1938 "type": "object",
1939 "properties": {
1940 "name": {
1941 "type": "string"
1942 },
1943 "description": {
1944 "type": "string"
1945 }
1946 }
1947 }
1948 }
1949 }
1950 },
1951 "example": {
1952 "code": "1500001",
1953 "message": "Invalid JWT."
1954 }
1955 }
1956 }
1957 },
1958 "403": {
1959 "description": "Forbidden",
1960 "content": {
1961 "application/json": {
1962 "schema": {
1963 "type": "object",
1964 "required": [
1965 "code",
1966 "message"
1967 ],
1968 "properties": {
1969 "code": {
1970 "type": "string"
1971 },
1972 "message": {
1973 "type": "string"
1974 },
1975 "description": {
1976 "type": "string"
1977 },
1978 "fields": {
1979 "type": "array",
1980 "items": {
1981 "type": "object",
1982 "properties": {
1983 "name": {
1984 "type": "string"
1985 },
1986 "description": {
1987 "type": "string"
1988 }
1989 }
1990 }
1991 }
1992 }
1993 },
1994 "example": {
1995 "code": "1500002",
1996 "message": "Required scopes are missing."
1997 }
1998 }
1999 }
2000 }
2001 }
2002 }
2003 },
2004 "/bespoke/visual-ivr/fsi/cards/{card_id}/activation/": {
2005 "post": {
2006 "tags": [
2007 "FSI Cards"
2008 ],
2009 "summary": "Inform when a card needs to be activate",
2010 "security": [
2011 {
2012 "Early Access": [
2013 "bespoke-vivr-fsi:write"
2014 ]
2015 }
2016 ],
2017 "requestBody": {
2018 "required": true,
2019 "content": {
2020 "application/json": {
2021 "schema": {
2022 "type": "object",
2023 "required": [
2024 "activation_code"
2025 ],
2026 "properties": {
2027 "activation_code": {
2028 "description": "The card activation code",
2029 "type": "string"
2030 }
2031 }
2032 },
2033 "example": {
2034 "activation_code": "79W&#K@zpxmg"
2035 }
2036 }
2037 }
2038 },
2039 "parameters": [
2040 {
2041 "in": "path",
2042 "name": "card_id",
2043 "schema": {
2044 "type": "string"
2045 },
2046 "required": true,
2047 "description": "The card id"
2048 }
2049 ],
2050 "responses": {
2051 "201": {
2052 "description": "Created"
2053 },
2054 "401": {
2055 "description": "Unauthorized",
2056 "content": {
2057 "application/json": {
2058 "schema": {
2059 "type": "object",
2060 "required": [
2061 "code",
2062 "message"
2063 ],
2064 "properties": {
2065 "code": {
2066 "type": "string"
2067 },
2068 "message": {
2069 "type": "string"
2070 },
2071 "description": {
2072 "type": "string"
2073 },
2074 "fields": {
2075 "type": "array",
2076 "items": {
2077 "type": "object",
2078 "properties": {
2079 "name": {
2080 "type": "string"
2081 },
2082 "description": {
2083 "type": "string"
2084 }
2085 }
2086 }
2087 }
2088 }
2089 },
2090 "example": {
2091 "code": "1500001",
2092 "message": "Invalid JWT."
2093 }
2094 }
2095 }
2096 },
2097 "403": {
2098 "description": "Forbidden",
2099 "content": {
2100 "application/json": {
2101 "schema": {
2102 "type": "object",
2103 "required": [
2104 "code",
2105 "message"
2106 ],
2107 "properties": {
2108 "code": {
2109 "type": "string"
2110 },
2111 "message": {
2112 "type": "string"
2113 },
2114 "description": {
2115 "type": "string"
2116 },
2117 "fields": {
2118 "type": "array",
2119 "items": {
2120 "type": "object",
2121 "properties": {
2122 "name": {
2123 "type": "string"
2124 },
2125 "description": {
2126 "type": "string"
2127 }
2128 }
2129 }
2130 }
2131 }
2132 },
2133 "example": {
2134 "code": "1500002",
2135 "message": "Required scopes are missing."
2136 }
2137 }
2138 }
2139 },
2140 "404": {
2141 "description": "Not Found",
2142 "content": {
2143 "application/json": {
2144 "schema": {
2145 "type": "object",
2146 "required": [
2147 "code",
2148 "message"
2149 ],
2150 "properties": {
2151 "code": {
2152 "type": "string"
2153 },
2154 "message": {
2155 "type": "string"
2156 },
2157 "description": {
2158 "type": "string"
2159 },
2160 "fields": {
2161 "type": "array",
2162 "items": {
2163 "type": "object",
2164 "properties": {
2165 "name": {
2166 "type": "string"
2167 },
2168 "description": {
2169 "type": "string"
2170 }
2171 }
2172 }
2173 }
2174 }
2175 },
2176 "example": {
2177 "code": "1500003",
2178 "message": "Resource not found."
2179 }
2180 }
2181 }
2182 }
2183 }
2184 }
2185 },
2186 "/bespoke/visual-ivr/fsi/sessions": {
2187 "get": {
2188 "tags": [
2189 "Visual IVR"
2190 ],
2191 "summary": "Retrieve information regarding the current VIVR session",
2192 "security": [
2193 {
2194 "Early Access": [
2195 "bespoke-vivr-fsi:read"
2196 ]
2197 }
2198 ],
2199 "responses": {
2200 "200": {
2201 "description": "Ok",
2202 "content": {
2203 "application/json": {
2204 "schema": {
2205 "type": "object",
2206 "required": [
2207 "id",
2208 "expire_date",
2209 "renewable"
2210 ],
2211 "properties": {
2212 "id": {
2213 "description": "VIVR FSI session id",
2214 "type": "string"
2215 },
2216 "expire_date": {
2217 "description": "VIVR FSI session expiry",
2218 "type": "string",
2219 "format": "date-time"
2220 },
2221 "renewable": {
2222 "description": "VIVR FSI session renewability",
2223 "type": "boolean"
2224 }
2225 }
2226 },
2227 "example": {
2228 "id": "d9d82ff32e54454595c1be16aff662d5",
2229 "expire_date": "2021-02-02T11:58:40.503Z",
2230 "renewable": false
2231 }
2232 }
2233 }
2234 },
2235 "401": {
2236 "description": "Unauthorized",
2237 "content": {
2238 "application/json": {
2239 "schema": {
2240 "type": "object",
2241 "required": [
2242 "code",
2243 "message"
2244 ],
2245 "properties": {
2246 "code": {
2247 "type": "string"
2248 },
2249 "message": {
2250 "type": "string"
2251 },
2252 "description": {
2253 "type": "string"
2254 },
2255 "fields": {
2256 "type": "array",
2257 "items": {
2258 "type": "object",
2259 "properties": {
2260 "name": {
2261 "type": "string"
2262 },
2263 "description": {
2264 "type": "string"
2265 }
2266 }
2267 }
2268 }
2269 }
2270 },
2271 "example": {
2272 "code": "1500001",
2273 "message": "Invalid JWT."
2274 }
2275 }
2276 }
2277 },
2278 "403": {
2279 "description": "Forbidden",
2280 "content": {
2281 "application/json": {
2282 "schema": {
2283 "type": "object",
2284 "required": [
2285 "code",
2286 "message"
2287 ],
2288 "properties": {
2289 "code": {
2290 "type": "string"
2291 },
2292 "message": {
2293 "type": "string"
2294 },
2295 "description": {
2296 "type": "string"
2297 },
2298 "fields": {
2299 "type": "array",
2300 "items": {
2301 "type": "object",
2302 "properties": {
2303 "name": {
2304 "type": "string"
2305 },
2306 "description": {
2307 "type": "string"
2308 }
2309 }
2310 }
2311 }
2312 }
2313 },
2314 "example": {
2315 "code": "1500002",
2316 "message": "Required scopes are missing."
2317 }
2318 }
2319 }
2320 }
2321 }
2322 }
2323 }
2324 }
2325}