ugosign - API Documentation

Introduction

Base URL: https://app.ugosign.com/

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Contacts

Get a contact list

GET

https://app.ugosign.com

/api/v1/contacts

requires authentication

This endpoint gives you a list of all your company's contacts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/contacts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create contact

POST

https://app.ugosign.com

/api/v1/contacts

requires authentication

This endpoint allows you to create a new contact

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

given_name

string

The given name of the contact.

Example:

Michel

family_name

string

The family name of the contact.

Example:

BLANC

gender

string

The gender of the contact. Example M.

Example:

veritatis

string

required

The email of the contact.

Example:

test@ugosign.com

phone_number

string

The phone number (international format) of the contact.

Example:

+33645854785

website

string

The website of the contact.

Example:

https://ugosign.com

street

string

The postal address of the contact.

Example:

24 RUE DU FAUBOURG SAINT HONORE

street_2

string

The postal address supplement of the contact.

Example:

Appartement 120

postal_code

string

The postal code of the contact.

Example:

75008

position

string

The position of the contact.

Example:

Engineer

birthdate

date

The birthdate of the contact.

Example:

1990-01-01

birthplace

string

The birthplace of the contact.

Example:

Lisbon

private_comment

string

A private comment about the contact.

Example:

Plays tennis on Saturdays

organization_name

string

The name of the company represented by the contact.

Example:

Hermès

siret_number

string

The siret number of the company represented by the contact.

Example:

57207639600017

vat_number

string

The siret number of the company represented by the contact.

Example:

FR52572076396

rcs_number

string

The siret number of the company represented by the contact.

Example:

572 076 396 R.C.S. Paris

Auth

Bearer

Headers

Body

{ "given_name": "Michel", "family_name": "BLANC", "gender": "veritatis", "email": "test@ugosign.com", "phone_number": "+33645854785", "website": "https:\/\/ugosign.com", "street": "24 RUE DU FAUBOURG SAINT HONORE", "street_2": "Appartement 120", "postal_code": "75008", "position": "Engineer", "birthdate": "1990-01-01", "birthplace": "Lisbon", "private_comment": "Plays tennis on Saturdays", "organization_name": "Herm\u00e8s", "siret_number": "57207639600017", "vat_number": "FR52572076396", "rcs_number": "572 076 396 R.C.S. Paris" }

Received response

Example request:

curl --request POST \
    "https://app.ugosign.com/api/v1/contacts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"given_name\": \"Michel\",
    \"family_name\": \"BLANC\",
    \"gender\": \"veritatis\",
    \"email\": \"test@ugosign.com\",
    \"phone_number\": \"+33645854785\",
    \"website\": \"https:\\/\\/ugosign.com\",
    \"street\": \"24 RUE DU FAUBOURG SAINT HONORE\",
    \"street_2\": \"Appartement 120\",
    \"postal_code\": \"75008\",
    \"position\": \"Engineer\",
    \"birthdate\": \"1990-01-01\",
    \"birthplace\": \"Lisbon\",
    \"private_comment\": \"Plays tennis on Saturdays\",
    \"organization_name\": \"Hermès\",
    \"siret_number\": \"57207639600017\",
    \"vat_number\": \"FR52572076396\",
    \"rcs_number\": \"572 076 396 R.C.S. Paris\"
}"

Get contact

GET

https://app.ugosign.com

/api/v1/contacts/{contact_id}

requires authentication

This endpoint allows you to view existing contacts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contact_id

string

required

The ID of the contact.

Example:

9b4b7ba9-3006-4c5b-89ec-00ea695f2a40

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/contacts/9b4b7ba9-3006-4c5b-89ec-00ea695f2a40" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update contact

PATCH

https://app.ugosign.com

/api/v1/contacts/{contact_id}

requires authentication

This endpoint allows you to update existing contacts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contact_id

string

required

The ID of the contact.

Example:

9b4b7ba9-3006-4c5b-89ec-00ea695f2a40

Body Parameters

given_name

string

The given name of the contact.

Example:

Michel

family_name

string

The family name of the contact.

Example:

BLANC

string

The email of the contact.

Example:

test@ugosign.com

phone_number

string

The phone number (international format) of the contact. .

Example:

+33645854785

street

string

The postal address of the contact.

Example:

24 RUE DU FAUBOURG SAINT HONORE

street_2

string

The postal address supplement of the contact.

Example:

Appartement 120

city

string

The city of the contact.

Example:

Paris

postal_code

string

The postal code of the contact.

Example:

75008

private_comment

string

A private comment about the contact.

Example:

Plays tennis on Saturdays

organization_name

string

The name of the company represented by the contact.

Example:

Hermès

siret_number

string

The siret number of the company represented by the contact.

Example:

57207639600017

vat_number

string

The siret number of the company represented by the contact.

Example:

FR52572076396

rcs_number

string

The siret number of the company represented by the contact.

Example:

572 076 396 R.C.S. Paris

Auth

Bearer

Headers

URL Parameters

Body

{ "given_name": "Michel", "family_name": "BLANC", "email": "test@ugosign.com", "phone_number": "+33645854785", "street": "24 RUE DU FAUBOURG SAINT HONORE", "street_2": "Appartement 120", "city": "Paris", "postal_code": "75008", "private_comment": "Plays tennis on Saturdays", "organization_name": "Herm\u00e8s", "siret_number": "57207639600017", "vat_number": "FR52572076396", "rcs_number": "572 076 396 R.C.S. Paris" }

Received response

Example request:

curl --request PATCH \
    "https://app.ugosign.com/api/v1/contacts/9b4b7ba9-3006-4c5b-89ec-00ea695f2a40" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"given_name\": \"Michel\",
    \"family_name\": \"BLANC\",
    \"email\": \"test@ugosign.com\",
    \"phone_number\": \"+33645854785\",
    \"street\": \"24 RUE DU FAUBOURG SAINT HONORE\",
    \"street_2\": \"Appartement 120\",
    \"city\": \"Paris\",
    \"postal_code\": \"75008\",
    \"private_comment\": \"Plays tennis on Saturdays\",
    \"organization_name\": \"Hermès\",
    \"siret_number\": \"57207639600017\",
    \"vat_number\": \"FR52572076396\",
    \"rcs_number\": \"572 076 396 R.C.S. Paris\"
}"

Delete contact

DELETE

https://app.ugosign.com

/api/v1/contacts/{contact_id}

requires authentication

This endpoint allows you to delete contacts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contact_id

string

required

The ID of the contact.

Example:

9b4b7ba9-3006-4c5b-89ec-00ea695f2a40

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://app.ugosign.com/api/v1/contacts/9b4b7ba9-3006-4c5b-89ec-00ea695f2a40" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contracts

Get contract list

GET

https://app.ugosign.com

/api/v1/contracts

requires authentication

This endpoint gives you a list of all your company's contracts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/contracts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get contract custom vars

GET

https://app.ugosign.com

/api/v1/contracts/{contract_id}/customVars

requires authentication

This endpoint allows you to get custom vars contract

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

string

required

The ID of the contract.

Example:

9d931ec9-3028-44d7-b47c-e019d9fe8b92

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/contracts/9d931ec9-3028-44d7-b47c-e019d9fe8b92/customVars" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get contract

GET

https://app.ugosign.com

/api/v1/contracts/{contract_id}

requires authentication

This endpoint allows you to view existing contracts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

string

required

The ID of the contract.

Example:

9d931ec9-3028-44d7-b47c-e019d9fe8b92

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/contracts/9d931ec9-3028-44d7-b47c-e019d9fe8b92" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create contract

POST

https://app.ugosign.com

/api/v1/contracts

requires authentication

This endpoint allows you to create a new contract

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

The contract title.

Example:

Certificat de formation

description

string

The contract description.

Example:

Formation immobilière

content

string

required

The contract content in HTML format.

Example:

dolor

footer

string

The contract footer in HTML format.

Example:

laudantium

Update contract

PATCH

https://app.ugosign.com

/api/v1/contracts/{contract_id}

requires authentication

This endpoint allows you to update existing contracts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

string

required

The ID of the contract.

Example:

9d931ec9-3028-44d7-b47c-e019d9fe8b92

Body Parameters

title

string

The contract title.

Example:

Certificat de formation

description

string

The contract description.

Example:

Formation immobilière

content

string

The contract content in HTML format.

Example:

amet

footer

string

The contract footer in HTML format.

Example:

dolorem

Delete contract

DELETE

https://app.ugosign.com

/api/v1/contracts/{contract_id}

requires authentication

This endpoint allows you to delete contracts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

string

required

The ID of the contract.

Example:

9d931ec9-3028-44d7-b47c-e019d9fe8b92

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://app.ugosign.com/api/v1/contracts/9d931ec9-3028-44d7-b47c-e019d9fe8b92" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Endpoints

GET api/status

GET

https://app.ugosign.com

/api/status

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "status": "ok"
}

GET api/v1/token-check

GET

https://app.ugosign.com

/api/v1/token-check

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/token-check" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Envelopes

Get Envelope list

GET

https://app.ugosign.com

/api/v1/envelopes/{status?}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

status

string

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/envelopes/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get Envelope

GET

https://app.ugosign.com

/api/v1/envelopes/{envelope}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

envelope

string

required

The envelope.

Example:

9b1b6720-90a3-4d7e-aa4b-6ae4eb21189f

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/envelopes/9b1b6720-90a3-4d7e-aa4b-6ae4eb21189f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Folders

Get folders list

GET

https://app.ugosign.com

/api/v1/folders

requires authentication

This endpoint gives you a list of all your company's folders

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/folders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create folder

POST

https://app.ugosign.com

/api/v1/folders

requires authentication

This endpoint allows you to create a new folder

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

The title of the folder.

Example:

Invoices

parent_id

string

The uuid parent folder of the new folder.

Example:

quia

Auth

Bearer

Headers

Body

{ "title": "Invoices", "parent_id": "quia" }

Received response

Example request:

curl --request POST \
    "https://app.ugosign.com/api/v1/folders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Invoices\",
    \"parent_id\": \"quia\"
}"

Members

Get members list

GET

https://app.ugosign.com

/api/v1/members

requires authentication

This endpoint gives you a list of all your company's members

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/members" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get representatives list

GET

https://app.ugosign.com

/api/v1/members/representatives

requires authentication

This endpoint gives you a list of all your company's representatives

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/members/representatives" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Organization

Get organization

GET

https://app.ugosign.com

/api/v1/organization

requires authentication

This endpoint gives you an organization summary

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.ugosign.com/api/v1/organization" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Signatures

Create signature request

POST

https://app.ugosign.com

/api/v1/signatures

requires authentication

This endpoint allows you to create a new signature request

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

contract_id

string

required

Related contract ID of the signature request.

Example:

5a9da901-7bab-43ea-b6fb-4bba84cc5087

recipients

string[]

required

An array of recipient emails.

Example:

["abcd@mail.com","defg@mail.com"]

initiator_id

string

The signature request initiator ID.

Example:

9b9da901-7bab-43ea-b6fb-4bba84cc5097

attachments

files

The signature request attachments.

Example:

eum

message

string

Personal message of the signature request in HTML format.

Example:

deserunt

verification_type

integer

The verification type of the signature request (1: Email, 2: SMS).

Example:

expiration_date

date

The expiration date of the signature request.

Example:

2024-11-03

confirm_customer_data

boolean

Enable contact data confirmation.

Example:

true

allow_refusal

boolean

Enable refusal.

Example:

true

initials

boolean

Affix the initials.

Example:

false

reminder

integer

Reminder in hours (24, 48, 72)

Example:

organization_presence

boolean

Presence of the company as a signatory

Example:

true

written_text

string

Text to be recopied by the signatory

Example:

veniam

Auth

Bearer

Headers

Body

{ "contract_id": "5a9da901-7bab-43ea-b6fb-4bba84cc5087", "recipients": [ "abcd@mail.com", "defg@mail.com" ], "initiator_id": "9b9da901-7bab-43ea-b6fb-4bba84cc5097", "attachments": "eum", "message": "deserunt", "verification_type": 13, "expiration_date": "2024-11-03", "confirm_customer_data": true, "allow_refusal": true, "initials": false, "reminder": 10, "organization_presence": true, "written_text": "veniam" }

Received response

Example request:

curl --request POST \
    "https://app.ugosign.com/api/v1/signatures" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contract_id\": \"5a9da901-7bab-43ea-b6fb-4bba84cc5087\",
    \"recipients\": [
        \"abcd@mail.com\",
        \"defg@mail.com\"
    ],
    \"initiator_id\": \"9b9da901-7bab-43ea-b6fb-4bba84cc5097\",
    \"attachments\": \"eum\",
    \"message\": \"deserunt\",
    \"verification_type\": 13,
    \"expiration_date\": \"2024-11-03\",
    \"confirm_customer_data\": true,
    \"allow_refusal\": true,
    \"initials\": false,
    \"reminder\": 10,
    \"organization_presence\": true,
    \"written_text\": \"veniam\"
}"