{"info":{"contact":{"email":"api@biglelegal.com"},"description":"A document sharing represents a document form that can be shared and sent, protected with a password if necessary, allowing external users complete document forms automatically. This answered forms will appear as a document in your workspace.","license":{"name":"","url":""},"termsOfService":"https://www.biglelegal.com/en/terms-and-conditions","title":"Bigle API Document Sharing","version":"v1.1.5"},"openapi":"3.0.1","paths":{"/status":{"get":{"description":"This endpoint returns the API status. You either get a successful response if the API is active or an error otherway.","summary":"Get endpoint status.","operationId":"status","tags":["Status"],"responses":{"200":{"description":"Successful Operation","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"environment":{"description":"The Bigle API environment.","type":"string"},"version":{"description":"The Bigle API version.","type":"string"},"requestId":{"description":"The unique request identifier used in the call.","type":"string"}}},"example":{"environment":"test","version":"1.0.0","requestId":"q92GjbPDysYMM7dHzCd4rLspz2qqwci5"}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"w3IA7vhr660m35hPqqA26t8Q8oq7mtEz"}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Internal server error"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Internal server error","requestId":"DMBBOqIDnG9o8ywj60BYDu6pU4kL98xt"}}}}},"security":[{"bearerSecurity":[]}]}},"/createDocumentSharing":{"post":{"description":"This endpoint returns a link to a document sharing, that may be protected with a password if it was indicated in the accessControl input parameter. This link can be directly opened using your navigator and it can be shared with other people. This endpoint also returns a reference to the documentSharing, allowing the user to make queries in the future to know more information","summary":"Create document sharing","operationId":"createDocumentSharing","tags":["Document Sharing"],"responses":{"200":{"description":"Successful Operation","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"publicSharedLink":{"description":"Public shared link. You can share it and anybody with this link will be able to complete the form.","type":"string"},"documentSharingUid":{"description":"UID of the document shared. This unique identifier will be useful in the future in order to know more information about the state of the sharing document.","type":"string"}}},"example":{"publicSharedLink":"https://diy.biglelegal.com/Public/Form?q=meolbazhsxsdcfygziraaow","documentSharingUid":"8jmNnI2urAkND60xsTy1iJ3DJ8Bdvcgm"}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"5NgHFu0B6nKbr1Y6WdEshglZbPxPxbTB"}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Request body should be informed","Document uid should be informed","Blocks should be informed","Access control should be true if password is informed","Password should be informed","Invalid document uid","Invalid blocks","Invalid access control","Invalid password","User does not exist","Document does not exist","Document sharing link could not be retrieved","Model blocks could not be retrieved from database","Model blocks do not exist","Password lenght should be at least 8 characters","Invalid status value","Status should be informed","Status value not accepted","Some block uids or clientIds specified do not exist in the corresponding automated model","Invalid block uid","Block uid sould be informed","Some client ID`s specified do not exist in the corresponding automated model","Invalid clientId","ClientId or blockUid should be informed","Only clientId or blockUid should be informed, not both","ClientId does not exist in our database"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Request body should be informed","requestId":"2SdbJ5kK3h2Oeg3u4Y30z8yPKs3imUH2"}}}}},"security":[{"bearerSecurity":[]}],"requestBody":{"description":"Request body to create a new document sharing link. If a block is not specified in the blocks array, the corresponding block will appear in the document sharing with editable status","content":{"application/json":{"schema":{"description":"Request body to create a new document sharing link. If a block is not specified in the blocks array, the corresponding block will appear in the document sharing with editable status","type":"object","properties":{"documentUid":{"description":"The reference of the document you want to create a document sharing from. You can easily obtain it looking for the documentUid query parameter in the url when you are in a concrete document.","type":"string"},"blocks":{"type":"array","items":{"description":"The blocks of an automated template you want to create a document sharing. You should set the uid or clientId of each block, as well as the status (visible, invisible, hidden).","type":"object","properties":{"status":{"description":"Enum that tells the status of each block.","enum":["EDITABLE","VISIBLE","HIDDEN"],"type":"string"},"uid":{"description":"The unique identifier of the block you want to appear in the documentSharing. (required if clientId is not informed)","type":"string"},"clientId":{"description":"Unique identifier of the block that can be set by the user in the platform. (required if uid is not informed)","type":"string"}}}},"accessControl":{"description":"The accessControl of the document sharing. You must set it to true in case you want the document sharing to be protected with password.","type":"boolean"},"password":{"description":"The password of the document sharing. For security reasons we require passwords with a minimum of 8 characters. In case the receiver of the link fails 3 times, we will logout them temporary and make them wait for a while in order to retry.","type":"string"}}},"example":{"documentUid":"askdfljaaoliue","blocks":[{"clientId":"test","status":"VISIBLE"},{"uid":"absdfsadkljf","status":"HIDDEN"}],"accessControl":true,"password":"passwordApi15."}}}}}}},"servers":[{"url":"https://europe-west1-bigle-platform.cloudfunctions.net/apiDocumentSharingEU-v1"}],"components":{"securitySchemes":{"bearerSecurity":{"type":"http","scheme":"bearer"}}}}