REST API
\nSerendpTech
Technology serving people
In the digital age, trust in companies and institutions depends on the right of every individual to have a digital identity that is not disclosed, safeguarded, or sold without his knowledge.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"24563234","collectionId":"1477e32b-2ced-4206-b555-758a200dd412","publishedId":"2s8YzUw1Ka","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"AC5391"},"publishDate":"2022-12-13T10:45:08.000Z"},"item":[{"name":"Authentification","item":[{"name":"Token","event":[{"listen":"test","script":{"exec":["pm.test(\"Response JSON\", function () {"," var jsonData = pm.response.json();"," pm.environment.set(\"seren_token\", jsonData.token);","});"],"type":"text/javascript","id":"a9a4da1c-bf4a-49ac-b5c1-cf2d2706edf5"}}],"id":"e8c22a0e-9863-4a7b-a320-3e6f1e92e773","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_key","value":"{{client_key}}","description":"(Required)
\n","type":"text"},{"key":"password","value":"{{password}}","description":"(Required)
\n","type":"text"}]},"url":"{{url_api}}/token","description":"Get Token
\n","urlObject":{"path":["token"],"host":["{{url_api}}"],"query":[],"variable":[]}},"response":[{"id":"19bf4696-f702-4e97-a688-50aa21221fc3","name":"Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_key","value":"{{client_key}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"{{url_api}}/token"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Company\",\n \"status_api\": true,\n \"token\": \"SFMyNTY.XXXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXX-XXXXXXXX-XXXXXXX-XXXXXXX\"\n}"}],"_postman_id":"e8c22a0e-9863-4a7b-a320-3e6f1e92e773"}],"id":"14f0b4f7-903e-4e63-a925-00912555e24a","_postman_id":"14f0b4f7-903e-4e63-a925-00912555e24a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{seren_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Retrieves a record (transaction) from the system using the session entity uuid value
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{seren_token}}"}],"advancedConfig":[{"key":"tokenType","value":"(Required)
\n","type":"text/plain"},"key":"uuid","value":"{{transaction_uuid_api}}"}],"variable":[]}},"response":[{"id":"6425a63b-08e6-4e88-bd32-5237d5b473ca","name":"Transaction detail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{seren_token}}","type":"text"}],"url":{"raw":"{{url_api}}/kyc/transaction/:uuid/detail","host":["{{url_api}}"],"path":["kyc","transaction",":uuid","detail"],"variable":[{"key":"uuid","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"capture_nfc\": \"text Nfc\",\n \"capture_ocr1\": \"text orc1\",\n \"capture_ocr2\": null,\n \"date\": \"2022-11-23T08:30:04Z\",\n \"device\": {\n \"model\": \"iphone 8\",\n \"os\": \"ios\",\n \"os_version\": \"12\",\n \"uuid\": \"b48f7530-8ea9-4b0e-921b-7f6a331033d2\"\n },\n \"document\": {\n \"country_name\": \"FRA\",\n \"date_of_birth\": \"1991-06-23\",\n \"expiration_date\": \"2020-05-11\",\n \"identifier\": \"10CH43771\",\n \"mrz\": \"P(Required)
\n","type":"text/plain"},"type":"any","value":"{{transaction_uuid_api}}","key":"uuid"}]}},"response":[{"id":"78c0a31c-0b87-4272-a40e-39ad8122fbbb","name":"Status of Transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":" Bearer {{seren_token}}","type":"text"}],"url":{"raw":"{{url_api}}/kyc/transaction/:uuid/status","host":["{{url_api}}"],"path":["kyc","transaction",":uuid","status"],"variable":[{"key":"uuid","value":"{{uuid_transaction_kyc}}","description":"(Required) The file uuid of the record."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"success\",\n \"uuid\": \"5aef5ea1-fd80-4995-92d8-d63ffbb986c7\"\n }\n}"}],"_postman_id":"0b2d56bd-6b4d-4bc8-83fd-3e4607c3f09a"},{"name":"Get list image files","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"d524080e-12e0-4e5f-b2a2-683cd0f2554e"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"a89e5cf0-0bfc-4b65-b408-5f500d4b7ffb"}}],"id":"5bbbbf90-eee8-48d3-847c-45b2400b8cac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url_api}}/kyc/transaction/:uuid/files?decrypt=1","description":"Return all files images of one transaction with its status:
\nIf you want to decrypt the files then use parameter decrypt=1 and check the status.
You can send request \"decrypt\" doc file
\n","type":"text/plain"},"key":"decrypt","value":"1"}],"variable":[{"id":"8ed0e706-678e-4882-b3cf-64b5a512fff0","description":{"content":"(Required) The file uuid of the record
\n","type":"text/plain"},"type":"any","value":"{{transaction_uuid_api}}","key":"uuid"}]}},"response":[{"id":"3f985ba2-8adb-4ebd-9074-8362826b606e","name":"Get list image file of Transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":" Bearer {{seren_token}}","type":"text"}],"url":{"raw":"{{url_api}}/kyc/transaction/:uuid/files","host":["{{url_api}}"],"path":["kyc","transaction",":uuid","files"],"query":[{"key":"decrypt","value":"1","description":"You can send request \"decrypt\" image file","disabled":true}],"variable":[{"key":"uuid","value":"{{uuid_transaction_kyc}}","description":"(Required) The file uuid of the record"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"blockchain_doc\": {\n \"status\": \"encrypt\"\n },\n \"full_path\": \"https://xxxxxxxxx/transactions/5aef5ea1-fd80-4995-92d8-d63ffbb986c7/provider/09105e97-6061-45a0-9738-1424ba9900dc_document_photo1.jpg\",\n \"name\": \"09105e97-6061-45a0-9738-1424ba9900dc_document_photo1.jpg\",\n \"uuid\": \"09105e97-6061-45a0-9738-1424ba9900dc\"\n },\n {\n \"blockchain_doc\": {\n \"status\": \"encrypt\"\n },\n \"full_path\": \"https://xxxxxxxxxx/transactions/5aef5ea1-fd80-4995-92d8-d63ffbb986c7/provider/a552411f-717e-44d1-859b-ca6e124b8e8c_id_identity_photo.jpg\",\n \"name\": \"a552411f-717e-44d1-859b-ca6e124b8e8c_id_identity_photo.jpg\",\n \"uuid\": \"a552411f-717e-44d1-859b-ca6e124b8e8c\"\n },\n {\n \"blockchain_doc\": {\n \"status\": \"encrypt\"\n },\n \"full_path\": \"https://xxxxxxxxxxxx/transactions/5aef5ea1-fd80-4995-92d8-d63ffbb986c7/provider/b8d2ae87-3d9d-4e63-9600-7c701eb31495_selfie_photo1.jpg\",\n \"name\": \"b8d2ae87-3d9d-4e63-9600-7c701eb31495_selfie_photo1.jpg\",\n \"uuid\": \"b8d2ae87-3d9d-4e63-9600-7c701eb31495\"\n },\n {\n \"blockchain_doc\": {\n \"status\": \"encrypt\"\n },\n \"full_path\": \"https://xxxxxxxxxxxxx/transactions/5aef5ea1-fd80-4995-92d8-d63ffbb986c7/provider/7c953458-0d90-41e3-b879-1a238f01b93a_selfie_photo2.jpg\",\n \"name\": \"7c953458-0d90-41e3-b879-1a238f01b93a_selfie_photo2.jpg\",\n \"uuid\": \"7c953458-0d90-41e3-b879-1a238f01b93a\"\n }\n ]\n}"}],"_postman_id":"5bbbbf90-eee8-48d3-847c-45b2400b8cac"},{"name":"Get list","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"6f43e00e-75de-4ce1-9848-e5359fe2dad5"}}],"id":"dd9561ef-5840-41de-886d-d158dd9666d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url_api}}/kyc/transaction?status=1&code_folder={{code_folder}}","description":"Return all transaction of client
\nIf you want to limit record the use parameter limit
If you want to filter status of transaction the use parameter status
Succes of transactionAbandoned of transactionAnomaly of transactionIf you want to fetch list transaction of folder the use parameter code_folder
The number of records to be returned
\n","type":"text/plain"},"key":"limit","value":"2"},{"description":{"content":"The status of records to be returned
\n","type":"text/plain"},"key":"status","value":"1"},{"description":{"content":"List transaction of folder to be returned
\n","type":"text/plain"},"key":"code_folder","value":"{{code_folder}}"}],"variable":[]}},"response":[{"id":"ef74d4af-d1c5-4d9c-9a7f-059d66d73599","name":"List Transactions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":" Bearer {{seren_token}}","type":"text"}],"url":{"raw":"{{url_api}}/kyc/transaction?status=1&code_folder={{code_folder}}","host":["{{url_api}}"],"path":["kyc","transaction"],"query":[{"key":"limit","value":"2","description":"The number of records to be returned","disabled":true},{"key":"status","value":"1","description":"The status of records to be returned"},{"key":"code_folder","value":"{{code_folder}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"capture_nfc\": \"text Nfc\",\n \"capture_ocr1\": \"text orc1\",\n \"capture_ocr2\": null,\n \"date\": \"2022-11-23T08:30:04Z\",\n \"device\": {\n \"model\": \"iphone 8\",\n \"os\": \"ios\",\n \"os_version\": \"12\",\n \"uuid\": \"5aef5ea1-fd80-4995-92d8-d63ffbb986c7\"\n },\n \"document\": {\n \"country_name\": \"FRA\",\n \"date_of_birth\": \"1991-06-23\",\n \"expiration_date\": \"2020-05-11\",\n \"identifier\": \"XXXXXXXXXXXX\",\n \"mrz\": \"PReturn:
\ncode and link image code that you can use for create transaction and fetch list transaction
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{seren_token}}"}],"advancedConfig":[{"key":"tokenType","value":"Required
\n","type":"text/plain"},"key":"user_email","value":"email@email.com"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"number_folder","value":"123456789"}],"variable":[]}},"response":[{"id":"e7312507-dbd4-459e-bcb8-499f4b1a0a1c","name":"Create Folder","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{url_api}}/kyc/initial?user_email={{email}}&code_folder={{code_folder}}","host":["{{url_api}}"],"path":["kyc","initial"],"query":[{"key":"user_email","value":"{{email}}","description":"Required"},{"key":"code_folder","value":"{{code_folder}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"code\": \"KA9H6KPPO\",\n \"code_folter\": \"TEST000000\",\n \"path_img_code\": \"https://XXXXXXXXXXXXXX/qrcode/5aef5ea1-fd80-4995-92d8-d63ffbb986c7.png\"\n }\n}"}],"_postman_id":"a8a1a37b-b40c-448d-8fc8-2e84b04fef9f"}],"id":"bf3c52cf-0d52-4912-a2bb-89aec8b8defd","_postman_id":"bf3c52cf-0d52-4912-a2bb-89aec8b8defd","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{seren_token}}"}],"advancedConfig":[{"key":"tokenType","value":"