Skip to the operations

Compliance

ZapSign in a decision flow.

5 ZapSign operations a decision flow can call directly, with the credentials your own contract issued. The response is data the rest of the flow reads, branches on, and keeps in the trace.

Category
Compliance
Type
Integration
Authentication
API key
Test environment
Production host only

Who they are

Brazilian electronic signature service aimed at small businesses.

ZapSign collects legally valid electronic signatures on documents built from an upload or from a stored template, and records how each signer was authenticated. It competes with the incumbents on price and on how little setup a first integration needs. The API is small enough to learn in an afternoon, which is much of its appeal.

What a flow can call

5 operations, each one a step you can place on the canvas.

  1. POST/api/v1/docs/

    Create a document to sign

    Uploads a PDF by URL and opens it for signature.

  2. POST/api/v1/models/create-doc/

    Create a document from a template

    Fills a template already held in ZapSign and opens it for signature.

  3. GET/api/v1/docs/$data.zapsign_doc_token/

    Check whether it has been signed

    The current state of a document and each signer.

  4. POST/api/v1/docs/$data.zapsign_doc_token/add-signer/

    Add a signer to a document

    Adds a party after the document exists — a guarantor the decision only asked for once the score came back, for example.

  5. GET/api/v1/signers/$data.zapsign_signer_token/

    Read one signer's status

    One signer's state, including the authentication they passed and when.

Where it sits in the decision

Compliance calls have a natural place in a flow.

Screening answers the parts of a decision a regulator will ask about, so what matters is not only the verdict but the record of it. A partial match is the interesting case: rarely a decline on its own, and usually the point where the flow opens a case for a reviewer with the match evidence attached.

Whatever ZapSign returns is part of the run, so it is part of the record. When someone asks months later why an applicant was declined, the answer cites what came back at the time rather than re-fetching from a service whose answer has since changed.

  • 01Add ZapSign as a connection authenticating with an API key.
  • 02ZapSign has one host for both environments, so guard test runs with your own credentials and limits.
  • 03Place a Connection node and pick an operation — “Create a document to sign” is usually the first one a flow needs.
  • 04Map the response into the fields your rules read, then test the whole path before it carries live traffic.

Common questions

Using ZapSign in a flow.

How do I connect ZapSign to a decision flow?

Add ZapSign as a connection in your workspace authenticating with an API key, with the credentials your own contract issued — ArboRule calls the provider as you, and never holds a contract on your behalf. Once the connection exists, any flow in the workspace can place a Connection node and choose one of its operations. The credentials live on the connection, not in the flow, so a policy owner can use ZapSign in a decision without ever seeing the secret.

Can I test ZapSign without touching production?

ZapSign exposes one host for both environments, so there is no separate sandbox to point at. Test runs still execute in Sandbox and are recorded separately in decision history, but the call goes to the same place as production — so guard it with your own test credentials, rate limits, or data.

What can a flow call on ZapSign?

5 operations, including “Create a document to sign”, “Create a document from a template”, “Check whether it has been signed”. Each one is a step you place on the canvas and map into the fields your rules read, and most flows start with “Create a document to sign”. The list comes from the same manifest the engine uses to make the call, so this page cannot describe an operation the product does not have.

Where in a decision should ZapSign be called?

Screening answers the parts of a decision a regulator will ask about, so what matters is not only the verdict but the record of it. A partial match is the interesting case: rarely a decline on its own, and usually the point where the flow opens a case for a reviewer with the match evidence attached.

Also in Compliance

Ready when you are

Wire ZapSign into a real decision.

Build the flow in Sandbox, connect your account, and watch the decision pull what it needs before it answers.

Read the docs