FAQs

What type of API documentation do you have?

We are using the OpenAPI (https://swagger.io/resources/open-api ) version 3 specification to document all our backend endpoints.

You can find the latest version here https://developers.circularo.com/developers/latest/OpenApi3.json

Please note this version is intended to be “read-only” and doesn’t contain any server specified.

You can also browse the documentation online using the “read-only” version of the swagger https://developers.circularo.com/developers/latest/rest-api

What kind of endpoint security do you use?

We are using API key authentication. After sign in you will receive token that you will send as query parameter named token in all oncoming requests.

What is the time validity of the token?

Standard token validity is 30 minutes. You can receive 30 days valid token if you specify parameter ”permanent”: true during login.

In the future version the token time validity will be specified in user settings and parameter permanent will be ommited.

Once the document is pushed to Circularo, is it Circularo who notifies the users that there is a document to be signed and provides the link?

Yes, the links will be sent from Circularo in notification emails.

Once the document is signed in Circularo, how will be our system notified?

Through a call in a workflow action.

Can Circularo push the signed document back to our system?

No, Circularo can notify an external API that the document is signed, but not push it. It needs to be downloaded by using the API.

Can we use workflow action script to call our API and send signed document attached?

No, the document must be downloaded using the API.