Welcome the the Invydio API collection.
\nIn order to call any of our APIs you need to get an API key that specific to you. In order to get an API key please contact info@amygdalab.net
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4710333","collectionId":"d0479ad4-611d-4d90-9604-61ff0d1679dd","publishedId":"SWLmW4J9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"A82956"},"publishDate":"2020-01-16T07:30:42.000Z"},"item":[{"name":"Authentication","item":[{"name":"V1","item":[{"name":"OAuth Client Credentials Token","id":"686b8658-7840-464f-a64d-718a59c13e91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"grant_type\": \"client_credentials\",\n\t\"client_id\": \"2\",\n\t\"scope\": \"download-assets\",\n\t\"client_secret\": \"5M6TYlonSp0D6fAf9jpBQR0TzFErawiYxGwDmNyP\"\n}"},"url":"https://{{URL}}/videoplatform/api/authentication/V1/oauth/token","description":"This API allows a consumer to authenticate against OAuth2 server and retrieve a Bearer token for further API Authorization that requires OAuth.
\nIn order to retreive the token, consumer must already have unique id and secret key.
\nSend the json content within the body of the POST request as following:
\n{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"YOUR_APP_CLIENT\",\n \"scope\": \"download-assets\",\n \"client_secret\": \"YOUR_APP_SECRET\"\n}
\n","urlObject":{"protocol":"https","path":["videoplatform","api","authentication","V1","oauth","token"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"80e53746-c1e8-419a-b051-b30840cf93f8","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"grant_type\": \"client_credentials\",\n\t\"client_id\": \"2\",\n\t\"scope\": \"download-assets\",\n\t\"client_secret\": \"ATwhae5iFCVnfWb3F0BwEFDXtEiEX5f6huj8gg5t\"\n}"},"url":"https://{{URL}}/videoplatform/api/authentication/V1/oauth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Feb 2020 08:12:40 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"118"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"Client authentication failed\",\n \"message\": \"Client authentication failed\"\n}"},{"id":"b4c5b097-c057-4027-845b-8bd832516492","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"grant_type\": \"client_credentials\",\n\t\"client_id\": \"1\",\n\t\"scope\": \"download-assets\",\n\t\"client_secret\": \"ATwhae5iFCVnfWb3F0BwEFDXtEiEX5f6huj8gg5t\"\n}"},"url":"https://{{URL}}/videoplatform/api/authentication/V1/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Feb 2020 08:10:12 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"1151"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjFjN2ZiYTMzZDg2YjNjNzM2M2ZmYTE5YjUwOGY1MjYzNDc3NGVmMzE4MjEzYTMxYmQ4ZTI2YjliZTJlYzNlMTM0NDgzZDk0YTA4MWY2NjhjIn0.eyJhdWQiOiIxIiwianRpIjoiMWM3ZmJhMzNkODZiM2M3MzYzZmZhMTliNTA4ZjUyNjM0Nzc0ZWYzMTgyMTNhMzFiZDhlMjZiOWJlMmVjM2UxMzQ0ODNkOTRhMDgxZjY2OGMiLCJpYXQiOjE1ODA3MTc0MTIsIm5iZiI6MTU4MDcxNzQxMiwiZXhwIjoxNTgwNzIxMDEyLCJzdWIiOiIiLCJzY29wZXMiOlsiZG93bmxvYWQtYXNzZXRzIl19.BFtLlfeHFkNEbdnT6HRjWS7vKuox7NCYM1ETxVNJeg95cg8BTD9PWcGaDRAKLhp2N_FQh7xDq-lCSCkWPVrLmXGP1NaYCU3qh-9TrXgwjwEbO6F0nQ-MTnaM2Eb4AaOGoXCWWoWR0yd-vgUYpH_33_7yC13TRTKUzq8Y-GX-VABHgI7ARgwhN0krMU9a96O137Qvu-gC387A33uszetXmxDgo8rSw3-41Bj9-yMpZat8E8hivgu9BrRC43YV6j6AmFPeU3PjwFIYXwFz7P6Y1KgxVDX36Qn7GMbv7rLCv1eZpBxypSRF2Rc_1g-zBo3B5b4g0_U7WpoV4WIz-FGrVFcVqGI1OUi6CZJyiH6nKSu1yrx4UiHjoIhSxeFaY3D5-D_LRqEYSuPidNOxckvNf5Q1fBUtQgovroQpmfXs6o851MgXn_89H77PXGqh3ggcxhYrhNHYySAUIUSCeHSBtudZfieKlsyIF87pLEcOChsDUi3HtHNf2-sCHN2NFaMN5_34h3nNJFUKccn2N4Ssl10ySfJnj3Mzqc_vSABmWcnFyAQYbV0KDlG0GgtxdzAErM3GQBiap1Lab8NOIsbZ-KzSpmXIlJ3GQqheVZEQvVFvA0mYnA-U_0aw4qZUdHQ-HAsT-80HILFNC0moATOWaOB4yGCJHC0TJzdWXXkv6Rc\"\n}"}],"_postman_id":"686b8658-7840-464f-a64d-718a59c13e91"},{"name":"OAuth Token Check","id":"e785d46a-2699-4254-b310-85e657920f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"https://{{URL}}/videoplatform/api/authentication/V1/check","description":"This is a API check resources that will perform a Authorization using already generated Bearer token agains our OAuth server
\n","urlObject":{"protocol":"https","path":["videoplatform","api","authentication","V1","check"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"2ce4e24b-460b-413a-b47d-81844fe5fdd9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"https://{{URL}}/videoplatform/api/authentication/V1/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Feb 2020 08:15:13 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IkFxS0VqRzB4YlZtc1kzOUJpdGNHQ2c9PSIsInZhbHVlIjoibjR0Mk54OXBWWVdQZFA0dHo5b2NuNFB2S3hnTjJKZTZrSEFRUWMrdW9MMFBHZWNYNVdLOWNnbGRkWEc2OG8ycCIsIm1hYyI6ImQ2MGEyZTVmZGZjYzU3YjhkZjk0ZWE2YjFlMTMxMzkwZGYxNjQwNTc1NTRkOWFiYjJmZjVkNDJmMjY0MWUxMmIifQ%3D%3D; expires=Mon, 03-Feb-2020 10:15:13 GMT; Max-Age=7200; path=/"},{"key":"Set-Cookie","value":"videoid_api_session=eyJpdiI6IjNyNnBUUGtIZmpBT05jVGJtK0NpblE9PSIsInZhbHVlIjoiUEtxWEpZakd3bkYxOVlhSmZlR0llSmJPR3FXY0t2QjZ6NkxvRXZEM2s2bE56dU1yZmhHY2wrN2NzRmo5ODNEdiIsIm1hYyI6IjBhNTFiMmFlMzJiOWMyODhhMTQ2NDNhY2EwYTc1Mzc5ZjA5MzhmYjczN2ZlZTNmN2ZkMDFlNzI5NzUzMmZmMWIifQ%3D%3D; expires=Mon, 03-Feb-2020 10:15:13 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Length","value":"20"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"Check OK!\"\n}"}],"_postman_id":"e785d46a-2699-4254-b310-85e657920f14"}],"id":"14be80a7-784e-4c20-a8ba-2427b13e8c64","_postman_id":"14be80a7-784e-4c20-a8ba-2427b13e8c64","description":""}],"id":"0bf073ec-a8ff-4605-bbb5-1e41c26b0b61","_postman_id":"0bf073ec-a8ff-4605-bbb5-1e41c26b0b61","description":""},{"name":"Session Management","item":[{"name":"V1","item":[{"name":"Create Session","id":"f8a7a873-6f66-4a5b-a53a-29441b9fce4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","type":"text","value":"MaltaMan2022"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"workflowId\": 23,\n \"orderno\": \"postman-test\",\n \"firstname\": \"John\",\n \"lastname\": \"Wayne\",\n \"fiscalcode\": \"MRARSS80A01D231K\",\n \"email\": \"test.customer@gmail.net\",\n \"mobilePhone\": \"3921234567\",\n \"address\": \"Via Piemonte 12\",\n \"country\": \"IT\",\n \"city\": \"Roma\",\n \"state\": \"Lazio\",\n \"zipCode\": \"15152\",\n \"sex\": \"M\",\n \"dateOfBirth\": \"1990-03-12\",\n \"placeOfBirth\": \"Viterbo\",\n \"language\": \"it\"\n}"},"url":"https://videoid.local/videoplatform/api/session_management/V1/sessions","description":"To enable a user to go through the predefined process, the platform needs to have the personal data of the user. This API will accept a collection of data of the user.
\nThe following fields are mandatory:
\nOptional fields are :
\nIf the user has any documents ex:- (Id Card, Passport, Driving License) that he needs to pass in documents array. Every document has an array of fields and it contains the the following fields.
\nAll fields are optional:
\n...\n\"documents\": [\n {\n \"documentType\": \"personal_id\",\n \"issuingAuthority\": \"Questura di Roma\",\n \"documentNumber\": \"AU-123456\",\n \"documentIssueDate\": \"2018-03-20\",\n \"expirationDate\": \"2022-03-20\",\n \"documentFile\": [\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA\"]\n }\n ],\n...\nThe field sex can take in the following values:
\nThe field documentType can take in the following values:
\nThis API will return all the sessions that are in certain status. The status can be added to the query as a parameter.
\nThe following fields are mandatory:
\nOptionally, you pass in the filters, completed_from and completed_to. It will work when the status 1 is passed.
\nThis will return you an array of objects with order numbers.
\nOperator Workflow
\nSelfie Workflow
\n","urlObject":{"protocol":"http","path":["videoplatform","api","session_management","V1","sessions_reports"],"host":["{{URL}}"],"query":[{"key":"status","value":"-1"},{"key":"tenantid","value":"27"},{"disabled":true,"key":"completed_from","value":"2019-06-16"},{"disabled":true,"key":"completed_to","value":"2019-09-16"}],"variable":[]}},"response":[{"id":"9823435a-6a4e-451f-8903-5ccf7aa24149","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"MaltaMan2019"}],"url":{"raw":"http://{{URL}}/videoplatform/api/session_management/V1/sessions_reports?status=-1&tenantid=21","protocol":"http","host":["{{URL}}"],"path":["videoplatform","api","session_management","V1","sessions_reports"],"query":[{"key":"status","value":"-1"},{"key":"tenantid","value":"21"},{"key":"completed_from","value":"2019-06-16","disabled":true},{"key":"completed_to","value":"2019-09-16","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Feb 2020 08:22:06 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"csrfCookie=59d7363981b190960d952bb5f59c06bf; expires=Mon, 03-Feb-2020 10:22:06 GMT; Max-Age=7200; path=/; secure; HttpOnly"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"87"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Data found\",\n \"data\": [\n {\n \"orderNumber\": \"ABVVV-1235\",\n \"status\": -1\n }\n ]\n}"}],"_postman_id":"41dbb152-653d-4208-a7fa-15af7421c20c"},{"name":"Get Session Status","id":"9f8fa51d-ba85-495a-9c7b-a1f652f9e75d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"MaltaMan2019"}],"body":{"mode":"raw","raw":""},"url":"https://{{URL}}/videoplatform/api/session_management/V1/sessions/:id/status","description":"This API will return current status of the session.
\n","urlObject":{"protocol":"https","path":["videoplatform","api","session_management","V1","sessions",":id","status"],"host":["{{URL}}"],"query":[{"disabled":true,"key":"id","value":""}],"variable":[{"type":"string","value":"8a508508-fadb-47b7-b7c5-0e2e33f7990c","key":"id"}]}},"response":[{"id":"7334ece8-23e3-48b9-9530-8f9c593356bb","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"MaltaMan2019"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{URL}}/videoplatform/api/session_management/V1/sessions/:id/status","protocol":"https","host":["{{URL}}"],"path":["videoplatform","api","session_management","V1","sessions",":id","status"],"query":[{"key":"id","value":"","disabled":true}],"variable":[{"key":"id","type":"string","value":"8a508508-fadb-47b7-b7c5-0e2e33f7990c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Jun 2020 12:37:42 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"csrfCookie=20a86de3a2a0e077f16276ccca746354; expires=Mon, 15-Jun-2020 14:37:42 GMT; Max-Age=7200; path=/; secure; HttpOnly"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Data found\",\n \"data\": {\n \"status\": -1\n }\n}"}],"_postman_id":"9f8fa51d-ba85-495a-9c7b-a1f652f9e75d"},{"name":"Download Assets","id":"564084e7-fafb-4b78-98ee-079dd58599bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"https://{{URL}}/videoplatform/api/session_management/V1/assets/:session_id/:assets_type","description":"This API resource will return all the assets for a specific session in a .zip archive file only if the client accessing the endpoint has the right ownership over the session id provided.
\nOptionally, you can pass assets_type as a filter to download the specific assets of session.
\nExample:\n?asset_type=signed_contracts
\n","urlObject":{"protocol":"https","path":["videoplatform","api","session_management","V1","assets",":session_id",":assets_type"],"host":["{{URL}}"],"query":[],"variable":[{"type":"string","value":"399e3260-42f2-4baa-b1d6-e631e8823da0","key":"session_id"},{"type":"string","value":"documents,summaryPDF,signed_contracts,uploaded_documents","key":"assets_type"}]}},"response":[],"_postman_id":"564084e7-fafb-4b78-98ee-079dd58599bf"},{"name":"Delete Session","id":"08f0d557-97ff-4685-89af-5fdc0ae53275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"https://{{URL}}/videoplatform/api/session_management/V1/delete_session/:session_id","urlObject":{"protocol":"https","path":["videoplatform","api","session_management","V1","delete_session",":session_id"],"host":["{{URL}}"],"query":[],"variable":[{"type":"string","value":"d81ebb3c-4228-40f8-babc-312f6fe4898a","key":"session_id"}]}},"response":[{"id":"bbffdf25-569a-450f-8ad6-93cc16ba72f0","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":{"raw":"https://{{URL}}/videoplatform/api/session_management/V1/delete_session/:session_id","protocol":"https","host":["{{URL}}"],"path":["videoplatform","api","session_management","V1","delete_session",":session_id"],"variable":[{"key":"session_id","value":"f3ed3ed3-1c4f-44d7-a9f3-74782c29dbc4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Feb 2020 08:24:22 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"csrfCookie=59d7363981b190960d952bb5f59c06bf; expires=Mon, 03-Feb-2020 10:24:22 GMT; Max-Age=7200; path=/; secure; HttpOnly"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"39"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"Session deleted successfully\"\n}"}],"_postman_id":"08f0d557-97ff-4685-89af-5fdc0ae53275"}],"id":"6f5f4abd-4231-44f4-86ab-bc0982e5bcf9","_postman_id":"6f5f4abd-4231-44f4-86ab-bc0982e5bcf9","description":""}],"id":"7d10a2e3-36a9-40be-89b5-147142c4990b","event":[{"listen":"prerequest","script":{"id":"cdcbe2e9-87d3-4403-97bf-03790ff157d2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aee8932d-8a4b-4981-b0b7-6775d2bb58c2","type":"text/javascript","exec":[""]}}],"_postman_id":"7d10a2e3-36a9-40be-89b5-147142c4990b","description":""}],"event":[{"listen":"prerequest","script":{"id":"3ea4cfa8-6df6-443c-8482-c5627b809a0e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f8211f63-7247-435f-b8f3-fe994a171eba","type":"text/javascript","exec":[""]}}]}