DOCSEARCHbyAlgolia
Submit Docs

BlueInk Developer Documentation

website·Indexed 30 days ago

https://hongphuc5497.netlify.app

Documentation for the BlueInk cloud-based e-signature API and SDKs. Includes technical reference for API v2 (2.2.3), covering authentication, rate limits, and bundle management, as well as client SDKs for Python, PHP, and JavaScript.

Tokens
13.6K
Snippets
67
Records
95
Agent score
73%

What's inside BlueInk

  1. Overview of Blueink eSignature API

    Blueink is a cloud-based eSignature API designed to integrate secure electronic signatures into applications. It provides a scalable platform for replacing paper-based processes with digital workflows, offering enterprise-class security, compliance, and a historic uptime of over 99.9%.

  2. Understand Packets and Persons in BlueInk

    • Packet: Represents a signer associated with a Bundle. It contains configuration such as authentication methods (e.g., selfie, SMS pin), delivery options (email, SMS, embedded), and the signer's current status.
    • Person: Represents the actual individual reviewing or signing documents. A Person has a name and one or more Contact Channels (emails/phone numbers).

    When creating a Bundle, BlueInk matches signer data to an existing Person. For precise control, you can retrieve a specific Person ID and include it in the Bundle Create request.

  3. Bundle object schema

    The Bundle object returned by the API contains metadata about the signing process, including status, participants (packets), associated documents, and custom data tags.
    [
  {
    "label": "string",
    "in_order": false,
    "email_subject": "string",
    "email_message": "string",
    "sms_message": "string",
    "requester_name": "string",
    "requester_email": "user@example.com",
    "cc_emails": ["user@example.com"],
    "custom_key": "string",
    "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
    "is_test": true,
    "status": "dr",
    "id": "string",
    "created": "2019-08-24T14:15:22Z",
    "docs_ready": true,
    "errors": [
      {
        "code": "authentication_failed",
        "message": "string",
        "errors": [{ "field": "string", "messsage": "string" }]
      }
    ],
    "packets": [
      {
        "name": "string",
        "email": "user@example.com",
        "phone": "string",
        "auth_sms": true,
        "auth_selfie": true,
        "auth_id": true,
        "id": "string",
        "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
        "status": "ne",
        "deliver_via": "email",
        "completed_at": "string",
        "last_accessed_at": "string",
        "order": 0
      }
    ],
    "documents": [
      {
        "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
        "key": "string",
        "name": "string"
      }
    ],
    "tags": ["string"],
    "data": [
      {
        "key": "string",
        "kind": "string",
        "label": "string",
        "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
        "packet_id": "7320cc64-cc5d-4058-b442-4f3247dcb469",
        "value": "string"
      }
    ]
  }
]

  4. Bundle object schema

    The Bundle object returned by the API contains metadata about the signing process, including status, requester details, and associated documents and packets. Key fields include:

    • status: Current state of the bundle (e.g., dr, se, st, co, ca, ex, fa).
    • packets: A list of signers/recipients and their authentication requirements (auth_sms, auth_selfie, auth_id).
    • documents: Templates and documents associated with the bundle.
    • tags: Custom labels applied to the bundle.
    • data: Key-value pairs associated with specific documents or packets.
    [
  {
    "label": "string",
    "status": "dr",
    "id": "string",
    "created": "2019-08-24T14:15:22Z",
    "requester_email": "user@example.com",
    "packets": [
      {
        "name": "string",
        "email": "user@example.com",
        "status": "ne",
        "deliver_via": "email"
      }
    ],
    "documents": [
      {
        "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
        "name": "string"
      }
    ],
    "tags": ["string"]
  }
]

  5. Understand BlueInk Bundles concept

    A Bundle represents one or more documents sent to one or more signers. In the API, all configuration (signers, documents, fields, and delivery options) is handled in a single REST request during creation. Once a Bundle is 'launched' (sent), the available API actions are limited.

  6. Understand BlueInk API versioning and connectivity

    The BlueInk API follows semantic versioning. All minor and patch versions of v2 are backwards compatible. The latest v2.X.X API is available at the path /api/v2/. All API requests must be made over HTTPS.

  7. Integrate Blueink API using official SDKs

    Once you have obtained your API key, you can use it with the official Blueink SDKs to implement e-signature functionality. Supported SDKs include Python, JavaScript, and PHP.

  8. Understand BlueInk Bundles

    A Bundle represents one or more documents sent to one or more signers. When using the API, all configurations (signers, documents, fields, and delivery options) are defined in a single REST request during creation. Once a Bundle is 'launched' (sent), the available API actions on that Bundle become limited.

  10. Authenticate requests to the BlueInk API

    The BlueInk API uses API keys for authentication. API keys identify your application and authorize it to perform actions on your behalf, such as sending documents for eSignature. API keys can be viewed and managed within the Apps section of the BlueInk Dashboard.

  11. Generate and secure a Blueink API key

    To integrate Blueink e-signature functionality, you must generate an API key from the Blueink Dashboard.

    1. Navigate to the Dashboard index page.
    2. Click the API tab in the sidebar.
    3. Click the Add API Key button.
    4. Enter a descriptive label for the API key and click Submit.
    5. Copy and save the generated API key in a secure location.

    Security Warning: API keys identify your application and authorize calls to the Blueink API. Never expose API keys in client-side code (e.g., browser-downloaded JavaScript files) or commit them to source control (e.g., GitHub repositories).