Skip to the operations

Compliance

Clicksign in a decision flow.

6 Clicksign 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
Separate sandbox host

Who they are

Brazilian electronic signature platform for regulated document flows.

Clicksign collects legally valid electronic signatures and holds the evidence each one needs — authentication method, timestamps and the signed document itself. It is the incumbent in the Brazilian market and is used where a contract has to survive a challenge, which is most of lending and insurance. Its newer API models an envelope holding several documents and signers rather than a single file.

What a flow can call

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

  1. POST/envelopes

    Create an envelope

    Opens a draft envelope. Nothing is sent yet — documents and signers are added to it, and only the activation call asks anyone to sign.

  2. POST/envelopes/$data.clicksign_envelope_id/signers

    Add a signer

    Adds a party to the envelope. Every signer needs at least one authentication requirement before the envelope can be activated, so a signer added without one blocks the activation rather than failing here.

  3. PATCH/envelopes/$data.clicksign_envelope_id

    Send it for signature

    Moves the envelope from draft to running, which is what actually notifies the signers.

  4. GET/envelopes/$data.clicksign_envelope_id

    Check whether it has been signed

    The envelope's current state. This is the read a flow does when it resumes: running means someone still has to sign, closed means it finished, and cancelled means it will not.

  5. GET/envelopes/$data.clicksign_envelope_id/documents

    List the documents in an envelope

    The documents the envelope holds and the state of each.

  6. GET/envelopes

    List envelopes

    Lists envelopes with the usual JSON:API filters.

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 Clicksign 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 Clicksign as a connection authenticating with an API key.
  • 02Clicksign runs a separate sandbox host, so a Sandbox flow can exercise the real call without touching production.
  • 03Place a Connection node and pick an operation — “Create an envelope” 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 Clicksign in a flow.

How do I connect Clicksign to a decision flow?

Add Clicksign 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 Clicksign in a decision without ever seeing the secret.

Can I test Clicksign without touching production?

Yes. Clicksign runs a separate sandbox host, so a flow executing in Sandbox can make the real call against test credentials and you can read the actual response shape in the trace before anything reaches a customer. The flow does not change when it graduates — only which credentials answer.

What can a flow call on Clicksign?

6 operations, including “Create an envelope”, “Add a signer”, “Send it for signature”. Each one is a step you place on the canvas and map into the fields your rules read, and most flows start with “Create an envelope”. 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 Clicksign 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 Clicksign 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