{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:signwell/document-send-reminder":{"post":{"operationId":"business_signwell_document_send_reminder","summary":"Send Reminder","description":"POST /api/v1/documents/{id}/remind","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a document."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/bulk-send-get-information":{"get":{"operationId":"business_signwell_bulk_send_get_information","summary":"Get Bulk Send","description":"GET /api/v1/bulk_sends/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier for a bulk send.","schema":{"type":"string","description":"Unique identifier for a bulk send."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/bulk-send-list-bulk-sendings":{"get":{"operationId":"business_signwell_bulk_send_list_bulk_sendings","summary":"List Bulk Sendings","description":"GET /api/v1/bulk_sends","tags":["business"],"parameters":[{"name":"user_email","in":"query","required":false,"description":"The email address of the user that sent the Bulk Send. Must have the `admin` or `manager` role to view Bulk Sends of other users. Defaults…","schema":{"type":"string","description":"The email address of the user that sent the Bulk Send. Must have the `admin` or `manager` role to view Bulk Sends of other users. Defaults…"}},{"name":"limit","in":"query","required":false,"description":"The number of documents to fetch. Defaults to 10, max is 50.","schema":{"type":"integer","default":10,"description":"The number of documents to fetch. Defaults to 10, max is 50."}},{"name":"page","in":"query","required":false,"description":"The page number for pagination. Defaults to the first page.","schema":{"type":"integer","default":1,"description":"The page number for pagination. Defaults to the first page."}},{"name":"api_application_id","in":"query","required":false,"description":"Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more…","schema":{"type":"string","description":"Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/bulk-send-create-validation-csv":{"post":{"operationId":"business_signwell_bulk_send_create_validation_csv","summary":"Create Bulk Send","description":"POST /api/v1/bulk_sends","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/bulk-send-get-csv-template":{"get":{"operationId":"business_signwell_bulk_send_get_csv_template","summary":"Get Bulk Send CSV Template","description":"GET /api/v1/bulk_sends/csv_template","tags":["business"],"parameters":[{"name":"template_ids[]","in":"query","required":true,"description":"Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The…","schema":{"type":"array","description":"Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The…"}},{"name":"base64","in":"query","required":false,"description":"A RFC 4648 base64 string of the template CSV file to be validated.","schema":{"type":"string","description":"A RFC 4648 base64 string of the template CSV file to be validated."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/bulk-send-validate-csv":{"post":{"operationId":"business_signwell_bulk_send_validate_csv","summary":"Validate Bulk Send CSV","description":"POST /api/v1/bulk_sends/validate_csv","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/bulk-send-get-documents":{"get":{"operationId":"business_signwell_bulk_send_get_documents","summary":"Get Bulk Send Documents","description":"GET /api/v1/bulk_sends/{id}/documents","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier for a bulk send.","schema":{"type":"string","description":"Unique identifier for a bulk send."}},{"name":"limit","in":"query","required":false,"description":"The number of documents to fetch. Defaults to 10, max is 50.","schema":{"type":"integer","default":10,"description":"The number of documents to fetch. Defaults to 10, max is 50."}},{"name":"page","in":"query","required":false,"description":"The page number for pagination. Defaults to the first page.","schema":{"type":"integer","default":1,"description":"The page number for pagination. Defaults to the first page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/document-get-document-data":{"get":{"operationId":"business_signwell_document_get_document_data","summary":"Get Document","description":"GET /api/v1/documents/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier for a document.","schema":{"type":"string","description":"Unique identifier for a document."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/document-delete-document":{"post":{"operationId":"business_signwell_document_delete_document","summary":"Delete Document","description":"DELETE /api/v1/documents/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a document."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/document-create-new-document":{"post":{"operationId":"business_signwell_document_create_new_document","summary":"Create Document","description":"POST /api/v1/documents","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/document-create-from-template":{"post":{"operationId":"business_signwell_document_create_from_template","summary":"Create Document from Template","description":"POST /api/v1/document_templates/documents","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/document-update-and-send":{"post":{"operationId":"business_signwell_document_update_and_send","summary":"Update and Send Document","description":"POST /api/v1/documents/{id}/send","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a document."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/document-get-completed-pdf":{"get":{"operationId":"business_signwell_document_get_completed_pdf","summary":"Completed PDF","description":"GET /api/v1/documents/{id}/completed_pdf","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier for a completed document.","schema":{"type":"string","description":"Unique identifier for a completed document."}},{"name":"url_only","in":"query","required":false,"description":"Whether to return the URL of the completed PDF or the actual PDF content. Defaults to `false`.","schema":{"type":"boolean","default":false,"description":"Whether to return the URL of the completed PDF or the actual PDF content. Defaults to `false`."}},{"name":"audit_page","in":"query","required":false,"description":"Whether to include the audit page as part of the document. Defaults to `true`","schema":{"type":"boolean","default":true,"description":"Whether to include the audit page as part of the document. Defaults to `true`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/template-get-template-data":{"get":{"operationId":"business_signwell_template_get_template_data","summary":"Get Template","description":"GET /api/v1/document_templates/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier for a template.","schema":{"type":"string","description":"Unique identifier for a template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/template-update-existing-template":{"post":{"operationId":"business_signwell_template_update_existing_template","summary":"Update Template","description":"PUT /api/v1/document_templates/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/template-delete-document-template":{"post":{"operationId":"business_signwell_template_delete_document_template","summary":"Delete Template","description":"DELETE /api/v1/document_templates/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a template."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/template-create-new":{"post":{"operationId":"business_signwell_template_create_new","summary":"Create Template","description":"POST /api/v1/document_templates","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/api-application-get-details":{"get":{"operationId":"business_signwell_api_application_get_details","summary":"Get API Application","description":"GET /api/v1/api_applications/{id}","tags":["business"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier for the API Application.","schema":{"type":"string","description":"Unique identifier for the API Application."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/api-application-delete-by-id":{"post":{"operationId":"business_signwell_api_application_delete_by_id","summary":"Delete API Application","description":"DELETE /api/v1/api_applications/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for the API Application."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/webhooks-get-all":{"get":{"operationId":"business_signwell_webhooks_get_all","summary":"List Webhooks","description":"GET /api/v1/hooks","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:signwell/webhooks-register-callback-url":{"post":{"operationId":"business_signwell_webhooks_register_callback_url","summary":"Create Webhook","description":"POST /api/v1/hooks","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/webhooks-delete-callback-url":{"post":{"operationId":"business_signwell_webhooks_delete_callback_url","summary":"Delete Webhook","description":"DELETE /api/v1/hooks/{id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a webhook."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:signwell/me-get-account-info":{"get":{"operationId":"business_signwell_me_get_account_info","summary":"Get credentials","description":"GET /api/v1/me","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}