### Making a GET Request with cURL Source: https://docs.signaturit.com/api/latest This example demonstrates how to make a GET request to the Signaturit API using cURL. It includes setting the Authorization header with a bearer token and specifying the API endpoint. ```bash $ curl -X GET -H "Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0" https://api.sandbox.signaturit.com/v3/signatures.json ``` -------------------------------- ### Making a POST Request with cURL for Error Handling Example Source: https://docs.signaturit.com/api/latest This cURL example illustrates how to make a POST request to the Signaturit API, including the Authorization header. It is presented in the context of demonstrating error handling, showing a typical request that might result in a 400 error. ```bash $ curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/signatures.json ``` -------------------------------- ### Branding Object Example Source: https://docs.signaturit.com/api/latest Example JSON object representing a branding configuration. It includes customizable application texts, creation date, ID, layout color, and text color. Logo and signature color are optional. ```json Object {application_texts:Object, created_at:"2014-08-26T10:04:00+0000", id:"3eed17f5-2d08-11e4-b3d4-0aa7697eb409", layout_color:"#FAAC58", templates:Array[0]…} application_texts: Object {send_button:"Sign", terms_and_conditions:"I will accept all this terms for testing purposes."} created_at: "2014-08-26T10:04:00+0000" id: "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" layout_color: "#FAAC58" templates: Array [0] [] text_color: "#B43104" ``` -------------------------------- ### GET /v3/brandings.json Source: https://docs.signaturit.com/api/latest Retrieves a list of all branding configurations associated with the authenticated account. ```APIDOC ## GET /v3/brandings.json ### Description Returns a list of brandings configured for the account, with optional filtering by date and pagination. ### Method GET ### Endpoint /v3/brandings.json ### Parameters #### Query Parameters - **limit** (integer) - Optional - Max results (max 10) - **offset** (integer) - Optional - Results offset - **since** (string) - Optional - Filter by creation date (YYYY-MM-DD) - **until** (string) - Optional - Filter by creation date (YYYY-MM-DD) ### Response #### Success Response (200) - **brandings** (array) - List of branding objects #### Response Example { "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58" } ``` -------------------------------- ### Create Branding with Template Source: https://docs.signaturit.com/api/latest Example of how to create a branding using a specific HTML template via cURL. ```APIDOC ## POST /v3/brandings.json ### Description Creates a new branding configuration using provided HTML templates. ### Method POST ### Endpoint `/v3/brandings.json` ### Request Body - **templates[template_name]** (string) - Required - The HTML content of the template. Magic words can be included. ### Request Example ```bash curl -X POST \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -d "templates[signatures_request]=
Sign the document
{{sign_button}}
" \ https://api.sandbox.signaturit.com/v3/brandings.json ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the created branding. - **created_at** (string) - The timestamp when the branding was created. - **application_texts** (array) - An array of application texts associated with the branding. #### Response Example ```json { "application_texts": [], "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409" } ``` ``` -------------------------------- ### Get All Subscriptions using cURL Source: https://docs.signaturit.com/api/latest This snippet demonstrates how to fetch all existing subscriptions using a GET request with cURL. Optional parameters like 'limit', 'offset', and 'event' can be used to filter the results. The response is a JSON array of subscription objects. ```bash $ curl \ -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/subscriptions.json ``` -------------------------------- ### GET /v3/brandings.json Source: https://docs.signaturit.com/api/latest Retrieves a list of all brandings in JSON format. ```APIDOC ## GET /v3/brandings.json ### Description Retrieves a list of all brandings in JSON format. ### Method GET ### Endpoint /v3/brandings.json ### Parameters #### Query Parameters None ### Request Example ```bash curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/brandings.json ``` ### Response #### Success Response (200) - **brandings** (array) - A list of branding objects. #### Response Example ```json [ { "application_texts": {}, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [] }, { "application_texts": [], "created_at": "2014-08-20T13:57:51+0000", "id": "eec5e47a-2871-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [] } ] ``` ``` -------------------------------- ### Retrieve Account Credits using cURL Source: https://docs.signaturit.com/api/latest This example shows how to retrieve the number of remaining credits in your Signaturit account using a GET request with cURL. The response provides credit data in JSON format, detailing different credit types and their usage. ```bash $ curl \ -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/account/credits.json ``` -------------------------------- ### Receive Webhook Events (JSON Example) Source: https://docs.signaturit.com/api/latest This example illustrates the structure of a received webhook event from Signaturit, specifically for a 'reminder_email_processed' event. The content is sent in JSON format. ```json { "created_at": "2015-02-25T13:38:33+0000", "document": { "email": "john@signaturit.com", "events": [ 3 ], "file": { "name": "John" }, "id": "29109781-f42d-11e4-b3d4-0aa7697eb409" }, "type": "reminder_email_processed" } ``` -------------------------------- ### Get Subscription Details via cURL Source: https://docs.signaturit.com/api/latest This snippet demonstrates how to retrieve the details of a specific subscription using a cURL GET request. It requires an authorization token and the subscription ID. ```bash $ curl \ -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json ``` -------------------------------- ### SMS Event Notification Example Source: https://docs.signaturit.com/api/latest Example JSON object representing a real-time notification received at the events URL for an SMS process. It includes timestamps, certificate details, and the event type, such as 'sms_processed'. ```json Object {created_at:"2015-02-25T13:38:33+0000", certificate:Object, type:"sms_processed"} created_at: "2015-02-25T13:38:33+0000" certificate: Object {created_at:"2014-08-21T08:53:35+0000", phone:"34123445566", events:Array[1], name:"John", status:"sent"…} type: "sms_processed" ``` -------------------------------- ### GET /v3/signatures.json Source: https://docs.signaturit.com/api/latest Retrieve a list of all signature requests. ```APIDOC ## GET /v3/signatures.json ### Description Get all signature requests. ### Method GET ### Endpoint /v3/signatures.json ### Parameters *Note: The provided text does not detail parameters or response structure for this endpoint. Please refer to the official API documentation for complete information.* ### Request Example ```bash curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/signatures.json ``` ### Response *Note: The provided text does not detail the response structure for this endpoint. Please refer to the official API documentation for complete information.* ``` -------------------------------- ### GET /v3/team/groups.json Source: https://docs.signaturit.com/api/latest Retrieves a list of all team groups. ```APIDOC ## GET /v3/team/groups.json ### Description Get team groups. ### Method GET ### Endpoint /v3/team/groups.json ### Response #### Success Response (200) - **groups** (array) - List of group objects. ### Response Example [ { "id": "d8125099-871e-11e6-88d5-06875124f8dd", "name": "Founders", "created_at": "2016-09-30T15:02:02+0000" } ] ``` -------------------------------- ### Create Signature Request with Template and Fields (cURL) Source: https://docs.signaturit.com/api/latest This cURL example illustrates creating a signature request using a template and pre-filling specific fields within that template. It includes recipient details, the template hashtag, and a data field for the widget ID. The API returns a JSON object with the signature request details. ```bash $ curl \ -X POST \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -d "recipients[0][name]=John" \ -d "recipients[0][email]=john.doe@gmail.com" \ -d "templates[0]=#NDA" \ -d "data[widget_id]=DEFAULT_VALUE" \ https://api.sandbox.signaturit.com/v3/signatures.json ``` -------------------------------- ### GET /v3/templates.json Source: https://docs.signaturit.com/api/latest Retrieves a list of templates available to the requester. Templates are pre-prepared documents for repeated use. ```APIDOC ## GET /v3/templates.json ### Description List templates from the requester. A template is a prepared document that can be sent repeatedly. ### Method GET ### Endpoint https://api.sandbox.signaturit.com/v3/templates.json ### Parameters #### Query Parameters - **limit** (integer) - Optional - Maximum number of templates to retrieve. The template limit is 100. - **offset** (integer) - Optional - Results offset. Default value is 0. #### Headers - **Authorization** (string) - Required - Bearer token for authentication (e.g., `Bearer YOUR_ACCESS_TOKEN`). ### Request Example ```bash curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/templates.json ``` ### Response #### Success Response (200) A collection of template objects in JSON format. #### Response Example ```json [ { "created_at": "2014-08-20T14:19:51+0000", "id": "e5d25677-8a52-11e3-af02-080027880ca6", "name": "#nda" } ] ``` ``` -------------------------------- ### List templates using Signaturit API Source: https://docs.signaturit.com/api/latest Retrieves a list of templates available to the requester. Examples provided for both v3 and v4 API versions with optional pagination parameters. ```cURL curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/templates.json ``` ```cURL curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v4/templates ``` -------------------------------- ### GET /v3/signatures/{id}/documents/{id}/download/signed Source: https://docs.signaturit.com/api/latest Downloads the final signed PDF document. ```APIDOC ## GET /v3/signatures/{id}/documents/{id}/download/signed ### Description Retrieves the binary content of the signed PDF document. ### Method GET ### Endpoint https://api.sandbox.signaturit.com/v3/signatures/{signId}/documents/{docId}/download/signed ### Response - **Binary** - The PDF file content. ``` -------------------------------- ### GET /v3/files/{id}.json Source: https://docs.signaturit.com/api/latest Retrieves a certified file by its ID. The response is in JSON format. ```APIDOC ## GET /v3/files/{id}.json ### Description This endpoint is used to get certificated files. The response is in JSON format. ### Method GET ### Endpoint /v3/files/{id}.json ### Parameters #### Path Parameters - **id** (string) - Required - Id of the file to be retrieved. ### Response #### Success Response (200) - **created_at** (string) - Timestamp of file creation. - **id** (string) - Unique identifier for the file. - **md5** (string) - MD5 hash of the file. - **name** (string) - Name of the certified file. - **size** (integer) - Size of the file in bytes. #### Response Example ```json { "created_at": "2023-08-03T11:27:24+0000", "id": "2e48685c-cf36-4320-8a2f-f62cd09bbfd3", "md5": "db35f1f6ec7d4aa23c8559c225f49fde", "name": "certifiedFile.pdf", "size": 485917 } ``` ``` -------------------------------- ### GET /v4/templates Source: https://docs.signaturit.com/api/latest Retrieves a list of templates available to the requester using the v4 API. Templates are pre-prepared documents for repeated use. ```APIDOC ## GET /v4/templates ### Description List templates from the requester. A template is a prepared document that can be sent repeatedly. ### Method GET ### Endpoint https://api.sandbox.signaturit.com/v4/templates ### Parameters #### Query Parameters - **limit** (integer) - Optional - Maximum number of templates to retrieve. The template limit is 10. - **page** (integer) - Optional - Results offset. Default value is 1. #### Headers - **Authorization** (string) - Required - Bearer token for authentication (e.g., `Bearer YOUR_ACCESS_TOKEN`). ### Request Example ```bash curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v4/templates ``` ### Response #### Success Response (200) A collection of template objects in JSON format. #### Response Example ```json [ { "created_at": "2025-04-30T06:32:56+0000", "id": "a86ca755-cc87-40e3-8147-d5c7c6d67536", "name": "#template-name", "widgets": [ { /* widget details */ }, { /* widget details */ } ] } ] ``` ``` -------------------------------- ### Signaturit API Authentication Header Example Source: https://docs.signaturit.com/api/latest This snippet shows how to format the Authorization header for API requests using an access token. The 'Authorization: Bearer YOUR_ACCESS_TOKEN' format is standard for token-based authentication. ```text Authorization: Bearer ZjEyMmE1ZDFhYmZiYzI2ZjkyMmUzYjczZDAyMmY5MzI0ZGYzN2Y0NzFhZjA5YzNhMjk2MTVmNjU1OTVhYTU0 ``` -------------------------------- ### GET /v3/emails/{id}/certificates/{id}/download/audit_trail Source: https://docs.signaturit.com/api/latest Downloads the binary content of the audit trail PDF for a specific email certificate. ```APIDOC ## GET /v3/emails/{id}/certificates/{id}/download/audit_trail ### Description Downloads the binary content of the audit trail PDF for a specific email certificate. This allows you to retrieve the proof of the email's lifecycle. ### Method GET ### Endpoint https://api.sandbox.signaturit.com/v3/emails/{id}/certificates/{id}/download/audit_trail ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the email. - **id** (string) - Required - The ID of the certificate. #### Query Parameters None ### Request Example ```curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/emails/6f6c974e-2910-11e4-b3d4-0aa7697eb409/certificates/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail ``` ### Response #### Success Response (200) - **file** (binary) - The audit trail PDF file content. #### Response Example (Binary PDF content) ``` -------------------------------- ### GET /v3/event-hooks Source: https://docs.signaturit.com/api/latest Retrieves a list of event hooks associated with the requester. Event hooks provide information about the signature process. ```APIDOC ## GET /v3/event-hooks ### Description List event hooks from the requester. The event hooks are the information sent about the signature process. ### Method GET ### Endpoint https://api.sandbox.signaturit.com/v3/event-hooks ### Parameters #### Query Parameters - **limit** (integer) - Optional - Maximum number of event hooks to retrieve. The limit is 100. - **page** (integer) - Optional - Page to be shown. Default value is 1. - **date** (string) - Optional - Stringified array of dates for filtering (e.g., `"{\"from\": \"2023-03-01\",\"to\": \"2023-03-28\"}"`). - **status** (array) - Optional - Status of the event hook. It must be an array. - **method** (array) - Optional - The HTTP method used for the request. It must be an array (e.g., `POST`, `GET`). - **search** (string) - Optional - String to search within event hooks. #### Headers - **Authorization** (string) - Required - Bearer token for authentication (e.g., `Bearer YOUR_ACCESS_TOKEN`). ### Request Example ```bash curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/event-hooks?method[]=POST&limit=2&page=4&search=email_&status[]=200 ``` ### Response #### Success Response (200) - **web_hooks** (array) - A collection of event hook objects. - **total** (integer) - The total number of event hooks found. #### Response Example ```json { "web_hooks": [ { "id": "LeWz6YYBdHtiVHKnGjII", "status_code": 200, "url": "http://www.webprovided.com", "method": "POST", "event_type": "email_processed", "created_at": "2023-03-28T07:21:39+0000" } ], "total": 2 } ``` ``` -------------------------------- ### GET /v3/sms/{id}/certificates/{id}/download/audit_trail Source: https://docs.signaturit.com/api/latest Downloads the audit trail PDF associated with a specific certified SMS certificate. ```APIDOC ## GET /v3/sms/{id}/certificates/{id}/download/audit_trail ### Description Retrieves the binary content of the audit trail PDF for a certified SMS. ### Method GET ### Endpoint /v3/sms/{id}/certificates/{id}/download/audit_trail ### Parameters #### Path Parameters - **id** (string) - Required - The SMS ID - **id** (string) - Required - The Certificate ID ### Response #### Success Response (200) - **Content-Type** (application/pdf) - Binary PDF file ``` -------------------------------- ### GET /v3/signatures/{id}/documents/{id}/download/sent Source: https://docs.signaturit.com/api/latest Downloads the configured or sent PDF file associated with a specific signature request. ```APIDOC ## GET /v3/signatures/{id}/documents/{id}/download/sent ### Description Download the configured/sent PDF file. ### Method GET ### Endpoint /v3/signatures/{id}/documents/{id}/download/sent ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier for the signature or document. ### Request Example curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/signatures/6f6c974e-2910-11e4-b3d4-0aa7697eb409/documents/29109781-f42d-11e4-b3d4-0aa7697eb409/download/sent ### Response #### Success Response (200) - **body** (binary) - The PDF file binary content. ``` -------------------------------- ### Get Certified File Information (cURL) Source: https://docs.signaturit.com/api/latest This snippet demonstrates how to retrieve information about a certified file using a cURL request. It requires the file ID and an authorization token. ```bash curl \ -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/files/3ccd2306-8b51-473e-adcf-b955b0f3a2d5.json ``` -------------------------------- ### Download SMS Audit Trail (cURL) Source: https://docs.signaturit.com/api/latest Example cURL request to download the binary content of an SMS audit trail PDF. It requires the SMS ID and the certificate ID, along with an authorization token. ```bash $ curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/sms/6f6c974e-2910-11e4-b3d4-0aa7697eb409/certificates/29109781-f42d-11e4-b3d4-0aa7697eb409/download/audit_trail ``` -------------------------------- ### List all brandings Source: https://docs.signaturit.com/api/latest Retrieves a list of all branding configurations associated with the account. Returns an array of branding objects. ```cURL curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/brandings.json ``` -------------------------------- ### Sandbox and Production Environments Source: https://docs.signaturit.com/api/latest Signaturit provides both Sandbox and Production environments for API integration. Use the Sandbox environment for testing and the Production environment for live operations. ```APIDOC ## Sandbox and Production Environments Signaturit offers separate environments for development and production. ### Sandbox Environment Use the Sandbox environment to test your integration thoroughly without affecting live data. **Endpoint URL:** `https://api.sandbox.signaturit.com/v3` #### Example cURL Request (Sandbox) ```bash $ curl -X GET -H "Authorization: Bearer YOUR_SANDBOX_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/signatures/count.json ``` ### Production Environment Once your integration is complete and tested in Sandbox, switch to the Production environment for live API calls. **Endpoint URL:** `https://api.signaturit.com/v3` #### Example cURL Request (Production) ```bash $ curl -X GET -H "Authorization: Bearer YOUR_PRODUCTION_ACCESS_TOKEN" https://api.signaturit.com/v3/signatures/count.json ``` ``` -------------------------------- ### POST /v3/brandings.json Source: https://docs.signaturit.com/api/latest Creates a new branding. ```APIDOC ## POST /v3/brandings.json ### Description Creates a new branding. ### Method POST ### Endpoint /v3/brandings.json ### Parameters #### Request Body - **application_texts** (object) - Optional - List with all the customizable texts for application widgets. - **send_button** (string) - Optional - Send button text. - **open_sign_button** (string) - Optional - Customizable text for Signature e-mail sign button. - **open_email_button** (string) - Optional - Customizable text for Certified e-mail sign button. - **terms_and_conditions** (string) - Optional - Text that follow our terms text (html code is allowed). - **layout_color** (string) - Optional - Primary element color. - **logo** (string) - Optional - The logo sent in emails (base64 encoded). - **signature_color** (string) - Optional - The color that will be used in the signature draw (only **black** and **blue** colors are allowed). - **templates** (object) - Optional - The template content for the emails sent to the user. See Custom templates section for more information. - **sms-templates** (object) - Optional - The template content for the SMS sent to the user. See Custom templates section for more information. - **text_color** (string) - Optional - Primary text color. - **show_csv** (boolean) - Optional - Hide or show the CSV image and text that is stamped in the signed file. - **show_biometric_hash** (boolean) - Optional - Hide or show the Biometric Hash in the signed document and audit trail. - **show_welcome_page** (boolean) - Optional - Hide or show the welcome page that appears before showing the document. - **header_color** (string) - Optional - Sign app Custom header color. - **footer_color** (string) - Optional - Sign app Custom footer color. - **name** (string) - Optional - To name the created branding. The maximum length allowed for this field is 24 characters. - **csv_position** (string) - Optional - Defines where the csv stamp will appear (only **right** or **left** values are allowed). ### Request Example ```bash curl -X POST \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -d "layout_color=#FAAC58" \ -d "text_color=#B43104" \ -d "application_texts[send_button]=Sign" \ -d "show_welcome_page=1" \ https://api.sandbox.signaturit.com/v3/brandings.json ``` ### Response #### Success Response (200) - **branding** (object) - The newly created branding object. #### Response Example ```json { "application_texts": { "send_button": "Sign" }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#FAAC58", "templates": [], "text_color": "#B43104" } ``` ``` -------------------------------- ### Create Signature Request with Widgets Source: https://docs.signaturit.com/api/latest Demonstrates how to create a signature request using multipart/form-data. This includes defining recipient widgets like signatures, dates, and text fields, and attaching a PDF file. ```bash curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -F "recipients[0][widgets][11][type]=signature" \ -F "recipients[0][widgets][11][height]=9.9784615384615" \ -F "recipients[0][widgets][11][width]=25" \ -F "recipients[0][widgets][12][default]=2017-07-27" \ -F "recipients[0][widgets][12][page]=1" \ -F "recipients[0][widgets][12][left]=35" \ -F "recipients[0][widgets][12][top]=1.5" \ -F "recipients[0][widgets][12][type]=date" \ -F "recipients[0][widgets][12][height]=5" \ -F "recipients[0][widgets][12][width]=30" \ -F "recipients[0][widgets][13][page]=1" \ -F "recipients[0][widgets][13][left]=20" \ -F "recipients[0][widgets][13][top]=5" \ -F "recipients[0][widgets][13][type]=text" \ -F "recipients[0][widgets][13][height]=5" \ -F "recipients[0][widgets][13][width]=30" \ -F "recipients[0][widgets][13][editable]=1" \ -F "recipients[0][widgets][13][options][validation_rule]=email" \ -F "files[0]=nda.pdf" \ https://api.sandbox.signaturit.com/v3/signatures.json ``` -------------------------------- ### Switching API Endpoints: Sandbox vs. Production cURL Source: https://docs.signaturit.com/api/latest This code snippet shows how to switch between the Signaturit sandbox and production API endpoints using cURL. It highlights the change in the URL and the need for different access tokens for each environment. ```bash **sandbox** $ curl -X GET -H "Authorization: Bearer YOUR_SANDBOX_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/signatures/count.json **production** $ curl -X GET -H "Authorization: Bearer YOUR_PRODUCTION_ACCESS_TOKEN" https://api.signaturit.com/v3/signatures/count.json ``` -------------------------------- ### GET /v3/team/users.json Source: https://docs.signaturit.com/api/latest Retrieves a list of all users currently associated with the team. ```APIDOC ## GET /v3/team/users.json ### Description Get team users. ### Method GET ### Endpoint /v3/team/users.json ### Response #### Success Response (200) - **users** (array) - List of team user objects. #### Response Example [ { "id": "d8125099-871e-11e6-88d5-06875124f8dd", "email": "john.doe@signaturit.com", "name": "John Doe", "role": "admin", "status": "active" } ] ``` -------------------------------- ### Widget Configurations Source: https://docs.signaturit.com/api/latest Details on configuring radio and check widgets for use in signature requests. ```APIDOC ## Widget Configurations ### Description Details on configuring radio and check widgets for use in signature requests. ### Radio Widget - **custom_id** (string) - Optional - Value to reference multiple radio widgets that belong to the same group. Only one widget within the same group can be selected. - **options[index]** (string) - Optional - Position of the widget in the group. Used for referencing the widget within the group. Two radio widgets with the same index on the same group will behave as the same widget. - **default** (string) - Optional - The default radio button selected for the group. The index value should be used for reference. All radio buttons widgets of the same group should have the same default value. ### Check Widget - **options** (string) - Optional - You can set `show_yes_no_option` as an option value to show Yes/No options with the widget. Only works with editable widgets. ``` -------------------------------- ### GET /v3/brandings/{id}.json Source: https://docs.signaturit.com/api/latest Retrieves a specific branding by its ID. ```APIDOC ## GET /v3/brandings/{id}.json ### Description Retrieves a specific branding by its ID. ### Method GET ### Endpoint /v3/brandings/{id}.json ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the branding to retrieve. ### Request Example ```bash curl -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/brandings/0b1db805-2cf7-11e4-b3d4-0aa7697eb409.json ``` ### Response #### Success Response (200) - **branding** (object) - The branding object. #### Response Example ```json { "application_texts": { "multi_page": "The pages that you need to sign in this test request are:", "photo": "We need a photo to fulfill this test request", "send_button": "Send!", "sign_button": "Sign!", "terms_and_conditions": "I will accept all this terms for testing purposes." }, "created_at": "2014-08-26T10:04:00+0000", "id": "3eed17f5-2d08-11e4-b3d4-0aa7697eb409", "layout_color": "#ACACAC", "templates": [], "text_color": "#FCFCFC" } ``` ``` -------------------------------- ### Create Branding with HTML Template using cURL Source: https://docs.signaturit.com/api/latest Demonstrates how to create a branding configuration by sending an HTML template to the Signaturit API. The template utilizes magic words like {{sign_button}} to inject interactive elements into the email body. ```bash curl -X POST \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -d "templates[signatures_request]=
Sign the document
{{sign_button}}
" \ https://api.sandbox.signaturit.com/v3/brandings.json ``` -------------------------------- ### GET /v3/subscriptions/{id}.json Source: https://docs.signaturit.com/api/latest Retrieves details of a specific subscription using its ID. ```APIDOC ## GET /v3/subscriptions/{id}.json ### Description Retrieves details of a specific subscription using its ID. ### Method GET ### Endpoint /v3/subscriptions/{id}.json ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/subscriptions/b2c7de2f-862c-11e6-88d5-06875124f8dd.json ``` ### Response #### Success Response (200) - **created_at** (string) - The timestamp when the subscription was created. - **events** (array) - An array of events the subscription is configured for. - **id** (string) - The unique identifier of the subscription. - **url** (string) - The URL where event notifications will be sent. #### Response Example ```json { "created_at": "2016-09-29T10:20:25+0000", "events": [ "*" ], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ``` ``` -------------------------------- ### GET /v3/account/credits.json Source: https://docs.signaturit.com/api/latest Retrieves the number of remaining credits for various Signaturit services in your account. ```APIDOC ## GET /v3/account/credits.json ### Description Retrieves the number of remaining credits for various Signaturit services in your account. ### Method GET ### Endpoint https://api.sandbox.signaturit.com/v3/account/credits.json ### Parameters No parameters required. ### Request Example ``` curl \ -X GET \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ https://api.sandbox.signaturit.com/v3/account/credits.json ``` ### Response #### Success Response (200) - An array of objects, where each object details the credits for a specific service type. - **type** (string) - The type of credit (e.g., 'dcf_spot', 'photo_id'). - **used_credits** (integer) - The number of credits used. - **quantity** (integer) - The total quantity of credits. - **remaining_credits** (integer) - The number of credits remaining. - **period** (string) - The period for which the credits are valid (e.g., 'monthly'). #### Response Example ```json [ { "type": "dcf_spot", "used_credits": 0, "quantity": 9999, "remaining_credits": 9999, "period": "monthly" }, { "type": "photo_id", "used_credits": 0, "quantity": 9999, "remaining_credits": 9999, "period": "monthly" } // ... other credit types ] ``` ``` -------------------------------- ### Create a new branding Source: https://docs.signaturit.com/api/latest Creates a new branding configuration with custom colors and application texts. Requires authentication and accepts optional parameters for styling and template customization. ```cURL curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -d "layout_color=#FAAC58" -d "text_color=#B43104" -d "application_texts[send_button]=Sign" -d "show_welcome_page=1" https://api.sandbox.signaturit.com/v3/brandings.json ``` -------------------------------- ### POST /v3/team/groups.json Source: https://docs.signaturit.com/api/latest Creates a new team group. ```APIDOC ## POST /v3/team/groups.json ### Description Create a new group. ### Method POST ### Endpoint /v3/team/groups.json ### Parameters #### Request Body - **name** (string) - Required - The name of the new group. ### Response #### Success Response (200) - **id** (string) - The ID of the created group. - **name** (string) - The name of the group. ### Response Example { "id": "d8125099-871e-11e6-88d5-06875124f8dd", "name": "Founders" } ``` -------------------------------- ### GET /v3/sms.json Source: https://docs.signaturit.com/api/latest Retrieves a list of all certified SMS requests with pagination and filtering options. ```APIDOC ## GET /v3/sms.json ### Description Get a list of all certified SMS requests. ### Method GET ### Endpoint /v3/sms.json ### Parameters #### Query Parameters - **limit** (integer) - Optional - Max number of SMS to retrieve (max 100) - **offset** (integer) - Optional - Results offset (default 0) - **status** (string) - Optional - Filter by status (in_queue, sent, error) - **since** (string) - Optional - Filter by date (YYYY-MM-DD) ### Response #### Success Response (200) - **sms_list** (array) - List of SMS objects #### Response Example [ { "id": "974e6f6c-2910-11e4-b3d4-0aa7697eb409", "created_at": "2014-08-21T08:53:35+0000" } ] ``` -------------------------------- ### Create Subscription with Specific Events via cURL Source: https://docs.signaturit.com/api/latest This snippet demonstrates creating a subscription for specific events, such as email processing and delivery, using a cURL POST request. It requires an authorization token, a notification URL, and a list of desired events. ```bash $ curl \ -X POST \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -d "url=https://httpbin.org/post" \ -d "events[0]=email_processed" \ -d "events[1]=email_delivered" \ https://api.sandbox.signaturit.com/v3/subscriptions.json ``` -------------------------------- ### GET /v3/sms/{id}.json Source: https://docs.signaturit.com/api/latest Retrieves details for a specific certified SMS request by its unique identifier. ```APIDOC ## GET /v3/sms/{id}.json ### Description Get a specific certified SMS request by ID. ### Method GET ### Endpoint /v3/sms/{id}.json ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the SMS request ### Response #### Success Response (200) - **id** (string) - SMS identifier - **created_at** (string) - Creation timestamp - **certificates** (array) - List of certificate items #### Response Example { "id": "6f6c974e-2910-11e4-b3d4-0aa7697eb409", "created_at": "2014-08-21T08:53:35+0000" } ``` -------------------------------- ### POST /v3/subscriptions.json Source: https://docs.signaturit.com/api/latest Creates a new subscription to receive event notifications. ```APIDOC ## POST /v3/subscriptions.json ### Description Creates a new subscription to receive event notifications. ### Method POST ### Endpoint /v3/subscriptions.json ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **url** (string) - Required - The URL where event information will be sent. - **events** (array) - Required - An array of events to subscribe to. Use "*" for all events. ### Request Example **Subscribing to all events:** ```bash curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -d "url=https://httpbin.org/post" -d "events[0]=*" https://api.sandbox.signaturit.com/v3/subscriptions.json ``` **Subscribing to specific email events:** ```bash curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -d "url=https://httpbin.org/post" -d "events[0]=email_processed" -d "events[1]=email_delivered" https://api.sandbox.signaturit.com/v3/subscriptions.json ``` ### Response #### Success Response (200) - **created_at** (string) - The timestamp when the subscription was created. - **events** (array) - An array of events the subscription is configured for. - **id** (string) - The unique identifier of the subscription. - **url** (string) - The URL where event notifications will be sent. #### Response Example ```json { "created_at": "2016-09-29T10:20:25+0000", "events": [ "*" ], "id": "b2c7de2f-862c-11e6-88d5-06875124f8dd", "url": "https://httpbin.org/post" } ``` ``` -------------------------------- ### GET /v3/sms/count.json Source: https://docs.signaturit.com/api/latest Retrieves the total count of certified SMS requests, with optional filtering by status and date. ```APIDOC ## GET /v3/sms/count.json ### Description Count certified SMS requests based on optional filters. ### Method GET ### Endpoint /v3/sms/count.json ### Parameters #### Query Parameters - **status** (string) - Optional - Filter SMS by status (in_queue, sent, error) - **since** (string) - Optional - Filter SMS sent at this date or later (YYYY-MM-DD) ### Response #### Success Response (200) - **count** (integer) - Total number of certified SMS #### Response Example { "count": 2 } ``` -------------------------------- ### POST /v3/files.json Source: https://docs.signaturit.com/api/latest Uploads a file for certification. Supports files less than or greater than 15MB, with chunked uploads. ```APIDOC ## POST /v3/files.json ### Description This endpoint is used to upload files and certificate them. It supports files less than 15MB and greater than 15MB, including chunked uploads for larger files. ### Method POST ### Endpoint /v3/files.json ### Parameters #### Request Body - **file** (file) - Required - File to be uploaded. - **chunk** (integer) - Optional - Number of the current chunk (for chunked uploads). - **chunks** (integer) - Optional - Number of total chunks (for chunked uploads). - **upload_key** (string) - Optional - Key to identify the file being uploaded. Mandatory for subsequent chunks. ### Request Example ```bash curl -X POST -F 'file=@"/certifiedFile.pdf"' -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.sandbox.signaturit.com/v3/files.json ``` ### Response #### Success Response (200) - **created_at** (string) - Timestamp of file creation. - **id** (string) - Unique identifier for the file. - **md5** (string) - MD5 hash of the file. - **name** (string) - Name of the certified file. - **size** (integer) - Size of the file in bytes. #### Response Example ```json { "created_at": "2023-08-03T11:27:24+0000", "id": "2e48685c-cf36-4320-8a2f-f62cd09bbfd3", "md5": "db35f1f6ec7d4aa23c8559c225f49fde", "name": "certifiedFile.pdf", "size": 485917 } ``` ``` -------------------------------- ### Create Subscription via cURL Source: https://docs.signaturit.com/api/latest This snippet shows how to create a new subscription using a cURL POST request. You need to provide a URL for event notifications and specify the events to subscribe to. An authorization token is required. ```bash $ curl \ -X POST \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -d "url=https://httpbin.org/post" \ -d "events[0]=*" \ https://api.sandbox.signaturit.com/v3/subscriptions.json ```