yousign_openapi.json in yousign_client-1.0.0 vs yousign_openapi.json in yousign_client-1.0.1
- old
+ new
@@ -16,18 +16,11 @@
"paths" : {
"/organizations" : {
"get" : {
"tags" : [ "Organizations" ],
"summary" : "List all Organizations",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -44,18 +37,11 @@
},
"/workspaces" : {
"get" : {
"tags" : [ "Workspaces" ],
"summary" : "List all Workspaces",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -72,18 +58,11 @@
},
"/users" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "List all Users",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -97,24 +76,10 @@
"post" : {
"tags" : [ "Users" ],
"summary" : "Create a new User on Yousign application",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/UserInput"
@@ -135,18 +100,11 @@
},
"/users/{id}" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "Find a User by ID",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/UserOutput"
@@ -157,24 +115,10 @@
"put" : {
"tags" : [ "Users" ],
"summary" : "Update a User",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/UserInput"
@@ -190,18 +134,11 @@
}
},
"delete" : {
"tags" : [ "Users" ],
"summary" : "Delete a User",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"204" : {
"description" : "Status 204"
}
}
@@ -219,18 +156,11 @@
"/user_groups" : {
"get" : {
"tags" : [ "User Groups" ],
"summary" : "Get User Group list",
"produces" : [ "application/json" ],
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -247,18 +177,11 @@
},
"/user_groups/{id}" : {
"get" : {
"tags" : [ "User Groups" ],
"summary" : "Find a User Group by ID",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/UserGroup"
@@ -281,24 +204,10 @@
"tags" : [ "Files" ],
"summary" : "Create a new File",
"description" : "Used to upload a file in base64 on our platform",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FileInput"
@@ -320,18 +229,11 @@
"/files/{id}" : {
"get" : {
"tags" : [ "Files" ],
"summary" : "Find a File by ID",
"description" : "Returns all the information regarding the File but without its content (for performance issue).",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/FileOutput"
@@ -352,18 +254,11 @@
"/files/{id}/download" : {
"get" : {
"tags" : [ "Files" ],
"summary" : "Download a File",
"description" : "Used to get the base64 content of a file",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "string",
@@ -388,25 +283,10 @@
"/files/{id}/duplicate" : {
"post" : {
"tags" : [ "Files" ],
"summary" : "Duplicate a File",
"description" : "Duplicate a file. It will be create a clone of this file, with a new ID.",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- } ],
"responses" : {
"201" : {
"description" : "Status 201",
"schema" : {
"$ref" : "#/definitions/FileOutput"
@@ -561,18 +441,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Order by createdAt\n\norder[createdAt]=asc\norder[createdAt]=desc",
"enum" : [ "asc", "desc" ]
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -606,24 +479,10 @@
"post" : {
"tags" : [ "Procedures" ],
"summary" : "Create a new Procedure",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProcedureInput"
@@ -647,18 +506,11 @@
},
"/procedures/{id}" : {
"get" : {
"tags" : [ "Procedures" ],
"summary" : "Find a Procedure by ID",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/ProcedureOutput"
@@ -672,24 +524,10 @@
"put" : {
"tags" : [ "Procedures" ],
"summary" : "Update a Procedure",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProcedureInput"
@@ -711,18 +549,11 @@
}
},
"delete" : {
"tags" : [ "Procedures" ],
"summary" : "Delete a Procedure",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"204" : {
"description" : "Status 204"
}
}
@@ -741,24 +572,10 @@
"post" : {
"tags" : [ "Procedures" ],
"summary" : "Duplicate a Procedure",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProcedureDuplicateInput"
@@ -885,18 +702,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Order by attribut",
"enum" : [ "asc", "desc" ]
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "string"
@@ -915,24 +725,10 @@
"post" : {
"tags" : [ "Procedures" ],
"summary" : "Remind a Procedure",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProcedureRemindInput"
@@ -963,18 +759,11 @@
"/procedures/{id}/proof" : {
"get" : {
"tags" : [ "Procedures" ],
"summary" : "Get a Procedure proof file",
"description" : "Get a Procedure proof file",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "string",
@@ -1006,18 +795,11 @@
"name" : "procedure",
"in" : "query",
"required" : false,
"type" : "string",
"x-example" : "Id for filter about a procedure"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Array of members",
"schema" : {
"type" : "array",
@@ -1032,24 +814,10 @@
"tags" : [ "Members" ],
"summary" : "Create a new Member",
"description" : "Create a new member",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/MemberInput"
@@ -1073,24 +841,10 @@
"tags" : [ "Members" ],
"summary" : "Edit a Member",
"description" : "Edit a member",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/MemberInput"
@@ -1107,18 +861,11 @@
},
"delete" : {
"tags" : [ "Members" ],
"summary" : "Delete a Member",
"description" : "Delete a member",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"204" : {
"description" : "Status 204"
}
}
@@ -1136,18 +883,11 @@
"/members/{id}/proof" : {
"get" : {
"tags" : [ "Members" ],
"summary" : "Get a proof file of a Member",
"description" : "Get a proof file of a member",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "string"
@@ -1176,24 +916,10 @@
"tags" : [ "File Objects" ],
"summary" : "Create a new File Object",
"description" : "Create a new fileObject",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FileObjectInput"
@@ -1215,18 +941,11 @@
"/file_objects/{id}" : {
"get" : {
"tags" : [ "File Objects" ],
"summary" : "Find a File Object by ID",
"description" : "Get a File Object",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/FileObjectOutput"
@@ -1238,24 +957,10 @@
"tags" : [ "File Objects" ],
"summary" : "Update a File Object",
"description" : "Update a File Object",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FileObjectInput"
@@ -1272,18 +977,11 @@
},
"delete" : {
"tags" : [ "File Objects" ],
"summary" : "Delete a File Object",
"description" : "Delete a File Object",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"204" : {
"description" : "Status 204"
}
}
@@ -1303,24 +1001,10 @@
"tags" : [ "Operations" ],
"summary" : "Create a new Operation",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/OperationInput"
@@ -1342,18 +1026,11 @@
"/operations/{id}" : {
"get" : {
"tags" : [ "Operations" ],
"summary" : "Find an Operation by ID",
"produces" : [ "application/json" ],
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/OperationOutput"
@@ -1373,18 +1050,11 @@
},
"/authentications/inwebo/{id}" : {
"get" : {
"tags" : [ "Authentications" ],
"summary" : "Get an Authentication",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/AuthenticationInweboOutput"
@@ -1395,24 +1065,10 @@
"put" : {
"tags" : [ "Authentications" ],
"summary" : "Update an inwebo Authentication",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"type" : "object",
@@ -1445,18 +1101,11 @@
},
"/authentications/sms/{id}" : {
"get" : {
"tags" : [ "Authentications" ],
"summary" : "Find an Authentication by ID",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/AuthenticationSmsOutput"
@@ -1468,24 +1117,10 @@
"tags" : [ "Authentications" ],
"summary" : "Update an SMS Authentication",
"consumes" : [ ],
"produces" : [ "application/json" ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"type" : "object",
@@ -1535,18 +1170,11 @@
},
"/authentications/email/{id}" : {
"get" : {
"tags" : [ "Authentications" ],
"summary" : "Find an Authentication by ID",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/AuthenticationEmailOutput"
@@ -1558,24 +1186,10 @@
"tags" : [ "Authentications" ],
"summary" : "Update an Email Authentication",
"consumes" : [ ],
"produces" : [ "application/json" ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"type" : "object",
@@ -1640,18 +1254,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "id of procedure (required if the member attribut is not set)",
"x-example" : "/procedures/17625df4-4ee7-498e-822d-3637c91b6f40"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -1666,24 +1273,10 @@
"tags" : [ "Consent Processes" ],
"summary" : "Create a new Consent Process",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ConsentProcessInput"
@@ -1712,18 +1305,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "id of member (required for anonymous)",
"x-example" : "/members/17625df4-4ee7-498e-822d-3637c91b6f40"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/ConsentProcessOutput"
@@ -1735,24 +1321,10 @@
"tags" : [ "Consent Processes" ],
"summary" : "Update a Consent Process",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ConsentProcessInput"
@@ -1768,18 +1340,11 @@
}
},
"delete" : {
"tags" : [ "Consent Processes" ],
"summary" : "Delete a Consent Process",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"204" : {
"description" : "Status 204"
}
}
@@ -1803,18 +1368,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "id of member (required for anonymous)",
"x-example" : "/members/17625df4-4ee7-498e-822d-3637c91b6f40"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/ConsentProcessValueOutput"
@@ -1841,18 +1399,11 @@
"in" : "query",
"required" : true,
"type" : "string",
"description" : "id of member",
"x-example" : "/members/17625df4-4ee7-498e-822d-3637c91b6f40"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/ConsentProcessValueOutput"
@@ -1864,24 +1415,10 @@
"tags" : [ "Consent Processes" ],
"summary" : "Create a new Consent Process Value",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ConsentProcessValueInput"
@@ -1902,18 +1439,11 @@
},
"/signature_uis" : {
"get" : {
"tags" : [ "Signature UIs" ],
"summary" : "Get Signature UI list",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -1928,24 +1458,10 @@
"tags" : [ "Signature UIs" ],
"summary" : "Create a new Signature UI",
"description" : "Here is the url format to build on your side to get a custom signature interface with your settings : \nhttps://webapp.yousign.com/procedure/sign?members=~2Fmembers~2F__MEMBER_ID__&signatureUi=~2Fsignature_uis~2F__SIGNATURE_UI_ID__",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SignatureUiInput"
@@ -1973,24 +1489,10 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "id of a signature ui",
"x-example" : "/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
} ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
@@ -2007,24 +1509,10 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "id of signature ui to update",
"x-example" : "/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
} ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
@@ -2041,24 +1529,10 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Id of the signature ui",
"x-example" : "/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
} ],
"responses" : {
"204" : {
"description" : "Status 204"
}
@@ -2089,18 +1563,11 @@
"name" : "signatureUi",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Filtering on id of signature ui resource"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"type" : "array",
@@ -2114,24 +1581,10 @@
"post" : {
"tags" : [ "Signature UIs" ],
"summary" : "Create a new Signature UI Label",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SignatureUiLabelInput"
@@ -2159,18 +1612,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "id of signature ui label",
"x-example" : "/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/SignatureUiLabelOutput"
@@ -2187,25 +1633,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Id of signature ui labels",
"x-example" : "/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
+ } , {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SignatureUiLabelInput"
@@ -2228,18 +1660,11 @@
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Id of signature ui label",
"x-example" : "/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- }, {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ } ],
"responses" : {
"204" : {
"description" : "Status 204"
}
}
@@ -2258,24 +1683,10 @@
"post" : {
"tags" : [ "Server Stamps" ],
"summary" : "Create a Server Stamp",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ServerStampInput"
@@ -2299,18 +1710,11 @@
},
"/server_stamps/{id}" : {
"get" : {
"tags" : [ "Server Stamps" ],
"summary" : "Find a Server Stamp by ID",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/ServerStampOutput"
@@ -2335,24 +1739,10 @@
"post" : {
"tags" : [ "Check Documents" ],
"summary" : "Verify an identity document (passport, id cards)",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CheckDocumentIdentitiesInput"
@@ -2373,17 +1763,11 @@
},
"/check-document/identities/{id}" : {
"get" : {
"tags" : [ "Check Documents" ],
"summary" : "Get informations about an identity document (passport, id cards)",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/CheckDocumentIdentitiesOutput"
@@ -2405,24 +1789,10 @@
"post" : {
"tags" : [ "Check Documents" ],
"summary" : "Verify a bank document (RIB)",
"consumes" : [ ],
"parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "The MIME type of the body of the request",
- "x-example" : "application/json"
- }, {
"name" : "body",
"in" : "body",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CheckDocumentBankAccountsInput"
@@ -2446,18 +1816,11 @@
},
"/check-document/bank_accounts/{id}" : {
"get" : {
"tags" : [ "Check Documents" ],
"summary" : "Get informations about a bank document (RIB)",
- "parameters" : [ {
- "name" : "Authorization",
- "in" : "header",
- "required" : true,
- "type" : "string",
- "description" : "Authentication credentials for HTTP authentication",
- "x-example" : "Bearer {{access_token}}"
- } ],
+ "parameters" : [ ],
"responses" : {
"200" : {
"description" : "Status 200",
"schema" : {
"$ref" : "#/definitions/CheckDocumentBankAccountsOutput"
@@ -2474,17 +1837,10 @@
"x-restlet" : {
"section" : "Check Document"
}
}
},
- "securityDefinitions" : {
- "ApiKey" : {
- "type" : "apiKey",
- "name" : "Authorization",
- "in" : "header"
- }
- },
"definitions" : {
"ConfigEmailTemplate" : {
"type" : "object",
"required" : [ "message", "subject", "to" ],
"properties" : {
@@ -2519,11 +1875,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Organization ID",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/organizations/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"name" : {
"type" : "string",
"description" : "Organization name"
@@ -2703,11 +2058,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Object's ID",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/workspaces/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"name" : {
"type" : "string",
"description" : "Workspace name"
@@ -2900,11 +2254,10 @@
"required" : [ "email", "firstname", "lastname" ],
"properties" : {
"id" : {
"type" : "string",
"description" : "Object's ID",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/users/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"firstname" : {
"type" : "string",
"description" : "User's firstname"
@@ -3011,11 +2364,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/inwebo_user_requests/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
}
},
"x-restlet" : {
"section" : "Users"
@@ -3025,11 +2377,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Object's ID",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/workspaces/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"name" : {
"type" : "string",
"description" : "Workspace name"
@@ -3044,11 +2395,10 @@
"required" : [ "name" ],
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/user_groups/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"name" : {
"type" : "string",
"description" : "Name of the UserGroup"
@@ -3122,11 +2472,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/files/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"name" : {
"type" : "string",
"description" : "Name of the file"
@@ -3172,11 +2521,10 @@
"example" : "/workspaces/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"creator" : {
"type" : "string",
"description" : "Id of creator",
- "pattern" : "^/users/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/users/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"sha256" : {
"type" : "string",
"description" : "File hash",
@@ -3464,11 +2812,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/procedures/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"name" : {
"type" : "string",
"description" : "Name of procedure"
@@ -3498,11 +2845,10 @@
"enum" : [ "draft", "active", "finished", "expired", "refused" ]
},
"creator" : {
"type" : "string",
"description" : "Id of creator of the object",
- "pattern" : "^/users/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/users/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"creatorFirstName" : {
"type" : "string",
"description" : "The creator's first name"
@@ -3512,11 +2858,10 @@
"description" : "The creator's last name"
},
"workspace" : {
"type" : "string",
"description" : "Id of workspace creator of the object",
- "pattern" : "^/workspaces/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/workspaces/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"template" : {
"type" : "boolean",
"description" : "Defines if the procedure is a template (if true). A template could be used by a procedure to get all properties of the template. Check parent parameter for more information."
@@ -3678,11 +3023,11 @@
"type" : "string",
"description" : "Procedure id reference"
},
"operationLevel" : {
"type" : "string",
- "enum" : [ "none", "custom" ]
+ "enum" : [ "none", "custom", "advanced" ]
},
"operationCustomModes" : {
"type" : "array",
"items" : {
"type" : "string",
@@ -3701,11 +3046,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/members/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"user" : {
"type" : "string",
"description" : "Internal user associated with the member. In this case, informations about the member will be informations of the user (first name, last name, phone number and email).",
@@ -3765,11 +3109,11 @@
"type" : "string",
"description" : "Procedure id reference"
},
"operationLevel" : {
"type" : "string",
- "enum" : [ "none", "custom" ]
+ "enum" : [ "none", "custom", "advanced" ]
},
"operationCustomModes" : {
"type" : "array",
"items" : {
"type" : "string",
@@ -3812,11 +3156,10 @@
"description" : "Page of the visible signature. This property is ignored if fieldName is set. \nIf you want a visible signature, you must set page, position and fieldName."
},
"position" : {
"type" : "string",
"description" : "Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr",
- "pattern" : "/^\\d+(,\\d+){3}$/",
"example" : "400,700,500,800"
},
"fieldName" : {
"type" : "string",
"description" : "[type=signature] Name of the signature field existing in the document, it will be not used on the signature image."
@@ -3884,11 +3227,10 @@
"required" : [ "file" ],
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/file_objects/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"file" : {
"$ref" : "#/definitions/FileOutput"
},
@@ -3898,11 +3240,10 @@
"description" : "Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName."
},
"position" : {
"type" : "string",
"description" : "Coordinates of the signature image to set. Format is : “llx,lly,urx,ury”. llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr",
- "pattern" : "/^\\d+(,\\d+){3}$/",
"example" : "400,700,500,800"
},
"fieldName" : {
"type" : "string",
"description" : "[type=signature] Name of the signature field existing in the document"
@@ -3986,11 +3327,10 @@
"description" : "Page of the visible signature. This property is ignored if fieldName is set. \nIf you want a visible signature, you must set page, position and fieldName."
},
"position" : {
"type" : "string",
"description" : "Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr",
- "pattern" : "/^\\d+(,\\d+){3}$/",
"example" : "400,700,500,800"
},
"fieldName" : {
"type" : "string",
"description" : "Name of the signature field existing in the document, it will be not used on the signature image."
@@ -4017,22 +3357,20 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/file_objects/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"page" : {
"type" : "integer",
"format" : "int32",
"description" : "Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName."
},
"position" : {
"type" : "string",
"description" : "Coordinates of the signature image to set. Format is : “llx,lly,urx,ury”. llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr",
- "pattern" : "/^\\d+(,\\d+){3}$/",
"example" : "400,700,500,800"
},
"fieldName" : {
"type" : "string",
"description" : "Name of the signature field existing in the document"
@@ -5156,11 +4494,11 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
+
"example" : "/check-document/identities/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"createdAt" : {
"type" : "string",
"format" : "date-time",
@@ -5301,11 +4639,10 @@
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "Id of the object",
- "pattern" : "^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$",
"example" : "/check-document/bank_accounts/9d1ede2b-5687-4440-bdc8-dd0bc64f668c"
},
"createdAt" : {
"type" : "string",
"format" : "date-time",
@@ -5411,7 +4748,19 @@
"Server Stamp" : {
"description" : "Allows to sign document by server stamp"
},
"Check Document" : { }
}
- }
-}
\ No newline at end of file
+ },
+ "securityDefinitions": {
+ "api_key": {
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+}