Introduction

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
Accept
Example:
application/json
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
Accept
Example:
application/json

Body Parameters

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\": \"ad\",
    \"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
Accept
Example:
application/json

URL Parameters

contact_id
string
required

The ID of the contact.

Example:
9b4b7ba9-3006-4c5b-89ec-00ea695f2a40
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
Accept
Example:
application/json

URL Parameters

contact_id
string
required

The ID of the contact.

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

Body Parameters

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
Accept
Example:
application/json

URL Parameters

contact_id
string
required

The ID of the contact.

Example:
9b4b7ba9-3006-4c5b-89ec-00ea695f2a40
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
Accept
Example:
application/json
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
https://app.ugosign.com
/api/v1/contracts/search
requires authentication

Allows you to search for a contract using a dynamic field (title, external_id, or id). Returns the corresponding contract or null if it doesn't exist.

Headers

Authorization
Example:
Bearer {YOUR_AUTH_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

field
string

Represents the search field. Must be title, external_id, or id.

Example:
external_id
s
string

The value to search for in the specified field.

Example:
abc123
Example request:
curl --request GET \
    --get "https://app.ugosign.com/api/v1/contracts/search?field=external_id&s=abc123" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:

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
Accept
Example:
application/json

URL Parameters

contract_id
string
required

The ID of the contract.

Example:
9d931ec9-3028-44d7-b47c-e019d9fe8b92
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
Accept
Example:
application/json

URL Parameters

contract_id
string
required

The ID of the contract.

Example:
9d931ec9-3028-44d7-b47c-e019d9fe8b92
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
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://app.ugosign.com/api/v1/contracts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Certificat de formation\",
    \"description\": \"Formation immobilière\",
    \"content\": \"debitis\",
    \"footer\": \"ea\",
    \"tags\": \"\\\"business,closed\\\"\",
    \"author_id\": \"9b9da901-7bab-43ea-b6fb-4bba84cc5097\",
    \"representative_id\": \"5a9da901-7bab-43ea-b6fb-4bba84cc5087\",
    \"folder_id\": \"8e6ua901-7bab-43ea-b6fb-4bba84cc4444\",
    \"confirm_customer_data\": true,
    \"allow_refusal\": false,
    \"initials\": false,
    \"reminder\": 24,
    \"external_id\": \"placeat\",
    \"external_revision_id\": \"inventore\"
}"

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
Accept
Example:
application/json

URL Parameters

contract_id
string
required

The ID of the contract.

Example:
9d931ec9-3028-44d7-b47c-e019d9fe8b92

Body Parameters

Example request:
curl --request PATCH \
    "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" \
    --data "{
    \"title\": \"Certificat de formation\",
    \"description\": \"Formation immobilière\",
    \"content\": \"blanditiis\",
    \"footer\": \"quae\",
    \"tags\": \"\\\"business,closed\\\"\",
    \"author_id\": \"9b9da901-7bab-43ea-b6fb-4bba84cc5097\",
    \"representative_id\": \"5a9da901-7bab-43ea-b6fb-4bba84cc5087\",
    \"folder_id\": \"8e6ua901-7bab-43ea-b6fb-4bba84cc4444\",
    \"confirm_customer_data\": true,
    \"allow_refusal\": false,
    \"initials\": true,
    \"reminder\": 24
}"

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
Accept
Example:
application/json

URL Parameters

contract_id
string
required

The ID of the contract.

Example:
9d931ec9-3028-44d7-b47c-e019d9fe8b92
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
Accept
Example:
application/json
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
Accept
Example:
application/json
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."
}

POST api/v1/gdrive-callback

POST
https://app.ugosign.com
/api/v1/gdrive-callback
requires authentication

Headers

Authorization
Example:
Bearer {YOUR_AUTH_KEY}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request POST \
    "https://app.ugosign.com/api/v1/gdrive-callback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

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
Accept
Example:
application/json

URL Parameters

status
string
Example:
qui
Example request:
curl --request GET \
    --get "https://app.ugosign.com/api/v1/envelopes/qui" \
    --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
Accept
Example:
application/json

URL Parameters

envelope
string
required

The envelope.

Example:
9b1b6720-90a3-4d7e-aa4b-6ae4eb21189f
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
Accept
Example:
application/json
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
Accept
Example:
application/json

Body Parameters

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\": \"aperiam\"
}"

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
Accept
Example:
application/json
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
Accept
Example:
application/json
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
Accept
Example:
application/json
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
Accept
Example:
application/json

Body Parameters

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\": \"optio\",
    \"message\": \"dolore\",
    \"verification_type\": 6,
    \"expiration_date\": \"2024-11-03\",
    \"confirm_customer_data\": true,
    \"allow_refusal\": false,
    \"initials\": true,
    \"reminder\": 9,
    \"organization_presence\": true,
    \"written_text\": \"accusamus\"
}"