FastSign API Documentation

FastSign API v1.0

Authentication

Authorization

HTTP authorization

Type: header

Scheme: token

Use the HTTP header Authorization with the prefix token before your API key. Your API key consists of public_id:secret_key.

Api-User-Uri

API key

Type: header

Impersonates the user by setting this header value to the URI of user.

Headers

Pagination-Page

Current page

Pagination-Items-Total

Total number of items in endpoint

Pagination-Num-Pages

Total number of pages

Customer API tokens

Get all customer API tokens

GET /customers/{customer_id}/api_tokens

Code samples

GET /customers/{customer_id}/api_tokens HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID

Example responses

200 response

[
    {
        "self": "/api/customers/15/api_tokens/104",
        "name": "string",
        "selector": "abcdef0123456789",
        "created_time": "2020-02-29 13:37:00"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer API tokens Array of ApiToken
4XX Error JsonProblemResponse

Create a new customer API token

POST /customers/{customer_id}/api_tokens

Code samples

POST /customers/{customer_id}/api_tokens HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "name": "string",
    "selector": "abcdef0123456789"
}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
body body application/json
ApiToken		 Yes

Example responses

201 response

{
    "self": "/api/customers/15/api_tokens/104",
    "name": "string",
    "selector": "abcdef0123456789",
    "created_time": "2020-02-29 13:37:00",
    "cleartext_secret": "abcdef0123456789"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
201 The newly created customer API token. The cleartext secret will only be shown once! ApiTokenCreateResult
4XX Error JsonProblemResponse

Get customer subscription

GET /customers/{customer_id}/api_tokens/{api_token_id}

Code samples

GET /customers/{customer_id}/api_tokens/{api_token_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
api_token_id path string No The customer API token ID

Example responses

200 response

{
    "self": "/api/customers/15/api_tokens/104",
    "name": "string",
    "selector": "abcdef0123456789",
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer API token ApiToken
4XX Error JsonProblemResponse

Deletes a customer API token

DELETE /customers/{customer_id}/api_tokens/{api_token_id}

Code samples

DELETE /customers/{customer_id}/api_tokens/{api_token_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
api_token_id path string No The customer API token ID

Example responses

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
204 Empty result if the API token was deleted
4XX Error JsonProblemResponse

Customer logotype

Get customer logotype

GET /customers/{customer_id}/logotype

Code samples

GET /customers/{customer_id}/logotype HTTP/1.1
Host: app.fastsign.se
Accept: image/*
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID

Example responses

200 response

[]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer logotype string
4XX Error JsonProblemResponse

Update a customer logotype

PUT /customers/{customer_id}/logotype

Code samples

PUT /customers/{customer_id}/logotype HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: image/*
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

[]

Send the binary image data as body. Valid image types are image/png, image/gif, image/jpeg

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
body body image/*
string (binary)		 Yes The image data

Example responses

200 response

[]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 The number of bytes written integer
4XX Error JsonProblemResponse

Customer subscriptions

Get all customer subscriptions

GET /customers/{customer_id}/subscriptions

Code samples

GET /customers/{customer_id}/subscriptions HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID

Example responses

200 response

[
    {
        "self": "/api/customers/9/subscriptions/10",
        "product": "/api/products/3",
        "price": 1,
        "valid_from_time": "2020-02-29 13:37:00",
        "valid_to_time": "2020-02-29 13:37:00",
        "cancelled_time": "2020-02-29 13:37:00",
        "notice_period": "string",
        "users_included": "string",
        "created_time": "2020-02-29 13:37:00"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer subscriptions Array of ApiCustomerSubscription
4XX Error JsonProblemResponse

Create a new customer subscription

POST /customers/{customer_id}/subscriptions

Code samples

POST /customers/{customer_id}/subscriptions HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "product": "/api/products/3",
    "valid_from_time": "2020-02-29 13:37:00",
    "valid_to_time": "2020-02-29 13:37:00"
}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
body body application/json
ApiCustomerSubscription		 Yes

Example responses

201 response

{
    "self": "/api/customers/9/subscriptions/10",
    "product": "/api/products/3",
    "price": 1,
    "valid_from_time": "2020-02-29 13:37:00",
    "valid_to_time": "2020-02-29 13:37:00",
    "cancelled_time": "2020-02-29 13:37:00",
    "notice_period": "string",
    "users_included": "string",
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
201 The newly created customer subscription ApiCustomerSubscription
4XX Error JsonProblemResponse

Get customer subscription

GET /customers/{customer_id}/subscriptions/{subscription_id}

Code samples

GET /customers/{customer_id}/subscriptions/{subscription_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
subscription_id path string No The customer subscription ID

Example responses

200 response

{
    "self": "/api/customers/9/subscriptions/10",
    "product": "/api/products/3",
    "price": 1,
    "valid_from_time": "2020-02-29 13:37:00",
    "valid_to_time": "2020-02-29 13:37:00",
    "cancelled_time": "2020-02-29 13:37:00",
    "notice_period": "string",
    "users_included": "string",
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer subscription ApiCustomerSubscription
4XX Error JsonProblemResponse

Update a customer subscription

PUT /customers/{customer_id}/subscriptions/{subscription_id}

Code samples

PUT /customers/{customer_id}/subscriptions/{subscription_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "product": "/api/products/3",
    "valid_from_time": "2020-02-29 13:37:00",
    "valid_to_time": "2020-02-29 13:37:00"
}

No properties are required, only set those properties needing a update

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
subscription_id path string No The customer subscription ID
body body application/json
ApiCustomerSubscription		 Yes

Example responses

200 response

{
    "self": "/api/customers/9/subscriptions/10",
    "product": "/api/products/3",
    "price": 1,
    "valid_from_time": "2020-02-29 13:37:00",
    "valid_to_time": "2020-02-29 13:37:00",
    "cancelled_time": "2020-02-29 13:37:00",
    "notice_period": "string",
    "users_included": "string",
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 The updated customer subscription ApiCustomerSubscription
4XX Error JsonProblemResponse

Customer users

Get all customer users

GET /customers/{customer_id}/users

Code samples

GET /customers/{customer_id}/users HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID

Example responses

200 response

[
    {
        "self": "/api/users/15",
        "permission_template": "CUSTOMER_ADMIN_USER",
        "firstname": "string",
        "lastname": "string",
        "username": "string",
        "password": "string",
        "email": "string",
        "active": true,
        "created_time": "2020-02-29 13:37:00"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer users Array of ApiUser
4XX Error JsonProblemResponse

Create a new customer user

POST /customers/{customer_id}/users

Code samples

POST /customers/{customer_id}/users HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "permission_template": "CUSTOMER_ADMIN_USER",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "password": "string",
    "email": "string",
    "active": true
}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
body body application/json
ApiUser		 Yes

Example responses

201 response

{
    "self": "/api/users/15",
    "permission_template": "CUSTOMER_ADMIN_USER",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "password": "string",
    "email": "string",
    "active": true,
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
201 The newly created customer user ApiUser
4XX Error JsonProblemResponse

Get customer user

GET /customers/{customer_id}/users/{user_id}

Code samples

GET /customers/{customer_id}/users/{user_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
user_id path string No The user ID

Example responses

200 response

{
    "self": "/api/users/15",
    "permission_template": "CUSTOMER_ADMIN_USER",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "password": "string",
    "email": "string",
    "active": true,
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Customer user ApiUser
4XX Error JsonProblemResponse

Update a customer user

PUT /customers/{customer_id}/users/{user_id}

Code samples

PUT /customers/{customer_id}/users/{user_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "permission_template": "CUSTOMER_ADMIN_USER",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "password": "string",
    "email": "string",
    "active": true
}

No properties are required, only set those properties needing a update

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
user_id path string No The user ID
body body application/json
ApiUser		 Yes

Example responses

200 response

{
    "self": "/api/users/15",
    "permission_template": "CUSTOMER_ADMIN_USER",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "password": "string",
    "email": "string",
    "active": true,
    "created_time": "2020-02-29 13:37:00"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 The updated customer user ApiUser
4XX Error JsonProblemResponse

Delete customer user

DELETE /customers/{customer_id}/users/{user_id}

Code samples

DELETE /customers/{customer_id}/users/{user_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
customer_id path string No The customer ID
user_id path string No The user ID

Example responses

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
204 Empty result if the customer user was deleted
4XX Error JsonProblemResponse

Payment options

Get all payment options

GET /payment_options

Code samples

GET /payment_options HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested

Example responses

200 response

[
    {
        "self": "/api/payment_options/3",
        "name": "string",
        "price": 1,
        "vat": 1,
        "email_required": true
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Payment options Array of ApiPaymentOption
4XX Error JsonProblemResponse

Get payment option

GET /payment_options/{payment_option_id}

Code samples

GET /payment_options/{payment_option_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
payment_option_id path string No The payment option ID

Example responses

200 response

{
    "self": "/api/payment_options/3",
    "name": "string",
    "price": 1,
    "vat": 1,
    "email_required": true
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Payment option ApiPaymentOption
4XX Error JsonProblemResponse

Products

Get all products

GET /products

Code samples

GET /products HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested

Example responses

200 response

[
    {
        "self": "/api/products/3",
        "name": "string",
        "type": "SUBSCRIPTION",
        "price": 1,
        "vat": 1,
        "unit": "string",
        "users_included": "string"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Products Array of ApiProduct
4XX Error JsonProblemResponse

Get product

GET /products/{product_id}

Code samples

GET /products/{product_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}
Api-User-Uri: API_KEY

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
product_id path string No The product ID

Example responses

200 response

{
    "self": "/api/products/3",
    "name": "string",
    "type": "SUBSCRIPTION",
    "price": 1,
    "vat": 1,
    "unit": "string",
    "users_included": "string"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Responses

Status Description Schema
200 Product ApiProduct
4XX Error JsonProblemResponse

Schemas

ApiContractSend

{
    "silent": true,
    "auto_sign": true
}

Properties

Name Type Required Restrictions Description
silent boolean No none True if the contract should be sent silently to the parties. Sending silently means no e-mail or SMS will be sent to parties.
auto_sign boolean No none True if the contract should be auto-signed on behalf of sending user. Must be enabled per API token, please contact support.

ApiContract

{
    "self": "/api/contracts/85",
    "name": "string",
    "content": "string",
    "pdf_preview_uri": "https://app.fastsign.se/contract_pdf_preview/i/85/encrypted_data",
    "email_invite_content": "string",
    "email_from_name": "string",
    "email_reply_to": "string",
    "party_order_defined": true,
    "show_identity_number": true,
    "require_auth": "NONE",
    "sent_time": "2020-02-29 13:37:00",
    "expire_time": "2020-02-29 13:37:00",
    "created_by": "/api/users/15",
    "created_time": "2020-02-29 13:37:00",
    "template": "/api/contract_templates/3",
    "is_answered": true,
    "is_signed": true,
    "is_rejected": true,
    "parties": [
        {
            "self": "/api/contracts/85/parties/452",
            "name": "string",
            "email": "string",
            "mobile_phone": "string",
            "identity_number": "string",
            "delivery_method": "EMAIL",
            "sign_type": "DEFAULT",
            "sign_order": "string",
            "is_accept": true,
            "sign_time": "2020-02-29 13:37:00",
            "reject_cause": "string",
            "created_by": "/api/users/15",
            "created_time": "2020-02-29 13:37:00",
            "contract_url": "https://app.fastsign.se/s/1YNb7Knv9Xl2WivR0A5l1q",
            "user": "/api/users/15"
        }
    ],
    "annotations": [
        {
            "self": "/api/contracts/85/annotations/86444",
            "party_id": "/api/contracts/85/parties/15",
            "pdf_page": "string",
            "pos_x": 1,
            "pos_y": 1,
            "width": 1,
            "height": 1,
            "type": "SIGNATURE",
            "content": "string",
            "input_required": true,
            "render_when_signed": true,
            "created_by": "/api/users/15",
            "created_time": "2020-02-29 13:37:00"
        }
    ]
}

Properties

Name Type Required Restrictions Description
self string No read-only
name string No none
content string No none
pdf_preview_uri string No read-only
email_invite_content string No none
email_from_name string No none
email_reply_to string No none
party_order_defined boolean No none Default is false. If true each party will get the notification about signing in a predefined order. For false, all parties will get the notification at the same time.
show_identity_number boolean No none Default is true. If true, the identity number of each party signed with digital ID will be visible on the signed contract.
require_auth string No none
enum, one of NONE, DIGITAL_ID, SMS		 Authentication type required before party can view and sign the contract.
sent_time string No read-only
expire_time string No none
created_by string No read-only
created_time string No read-only
template string No none
is_answered boolean No read-only True if at least one party has answered. If this property is true and is_signed is false, the contract is rejected.
is_signed boolean No read-only True if all parties accepted the contract.
is_rejected boolean No read-only True if any of the parties rejected the contract.
parties Array of ApiContractParty Yes none A party can be created in two ways;
* setting the name property in conjunction with email or mobile_phone
* setting the user_id property
annotations Array of ApiContractAnnotation Yes none

ApiContractActivityLog

{
    "time": "2020-02-29 13:37:00",
    "event": "string",
    "user_agent": "string",
    "ip_address": "string"
}

Properties

Name Type Required Restrictions Description
time string Yes read-only
event string Yes read-only
user_agent string No read-only
ip_address string No read-only

ApiContractAnnotation

{
    "self": "/api/contracts/85/annotations/86444",
    "party_id": "/api/contracts/85/parties/15",
    "pdf_page": "string",
    "pos_x": 1,
    "pos_y": 1,
    "width": 1,
    "height": 1,
    "type": "SIGNATURE",
    "content": "string",
    "input_required": true,
    "render_when_signed": true,
    "created_by": "/api/users/15",
    "created_time": "2020-02-29 13:37:00"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
party_id string No none
pdf_page integer Yes none
pos_x number Yes none Horizontal position in percentages of PDF page width
pos_y number Yes none Vertical position in percentages of PDF page height
width number Yes none Width in percentages of PDF page width
height number Yes none Height in percentages of PDF page height
type string Yes none
enum, one of SIGNATURE, NOTE, CHECKBOX, INPUT_TEXT
content string No none If type is set to SIGNATURE this property should contain the numeric ID of the party whose signature this annotation belongs to.
input_required boolean No none
render_when_signed boolean No none
created_by string Yes read-only
created_time string Yes read-only

ApiContractAttachment

{
    "self": "/api/contracts/85/attachments/5356",
    "name": "string",
    "preview_uri": "https://app.fastsign.se/contract_attachment_preview/i/5356/encrypted_data",
    "created_by": "/api/users/15",
    "created_time": "2020-02-29 13:37:00"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string Yes none
preview_uri string Yes read-only
created_by string Yes read-only
created_time string Yes read-only

ApiContractParty

{
    "self": "/api/contracts/85/parties/452",
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": "string",
    "is_accept": true,
    "sign_time": "2020-02-29 13:37:00",
    "reject_cause": "string",
    "created_by": "/api/users/15",
    "created_time": "2020-02-29 13:37:00",
    "contract_url": "https://app.fastsign.se/s/1YNb7Knv9Xl2WivR0A5l1q",
    "user": "/api/users/15"
}

A party can be created in two ways;

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string No none Can't be used together with user_id
email string No none Can't be used together with user_id
mobile_phone string No none Can't be used together with user_id
identity_number string No none Used when the contract requires authentication. Can't be used together with user_id.
delivery_method string No none
enum, one of EMAIL, SMS, EMAIL,SMS
sign_type string Yes none
enum, one of DEFAULT, DIGITAL_ID, NONE
sign_order integer No none The order in which this party should sign the contract. Only valid for party_order_defined being true on ApiContract.
is_accept boolean No read-only
sign_time string No read-only
reject_cause string No read-only
email_status ApiContractPartyMailSummary No none
created_by string Yes read-only
created_time string Yes read-only
contract_url string Yes read-only
user string No none Set this property if party is internal FastSign user. Use self as value for the authenticated user or a URI to other user.

ApiContractPartyMailSummary

{
    "sent": true,
    "opened": true,
    "clicked": true,
    "bounced": true,
    "hardbounced": true,
    "softbounced": true,
    "blocked": true,
    "unsub": true,
    "spam": true
}

Properties

Name Type Required Restrictions Description
sent boolean No read-only
opened boolean No read-only
clicked boolean No read-only
bounced boolean No read-only
hardbounced boolean No read-only
softbounced boolean No read-only
blocked boolean No read-only
unsub boolean No read-only
spam boolean No read-only

ApiContractSubset

{
    "self": "/api/contracts/85",
    "name": "string",
    "content": "string",
    "pdf_preview_uri": "https://app.fastsign.se/contract_pdf_preview/i/85/encrypted_data",
    "email_invite_content": "string",
    "email_from_name": "string",
    "email_reply_to": "string",
    "party_order_defined": true,
    "show_identity_number": true,
    "require_auth": "NONE",
    "sent_time": "2020-02-29 13:37:00",
    "expire_time": "2020-02-29 13:37:00",
    "created_by": "/api/users/15",
    "created_time": "2020-02-29 13:37:00",
    "template": "/api/contract_templates/3",
    "is_answered": true,
    "is_signed": true,
    "is_rejected": true
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string Yes none
content string No none
pdf_preview_uri string No read-only
email_invite_content string Yes none
email_from_name string No none
email_reply_to string No none
party_order_defined boolean No none Default is false. If true each party will get the notification about signing in a predefined order. For false, all parties will get the notification at the same time.
show_identity_number boolean No none Default is true. If true, the identity number of each party signed with digital ID will be visible on the signed contract.
require_auth string No none
enum, one of NONE, DIGITAL_ID, SMS		 Authentication type required before party can view and sign the contract.
sent_time string No read-only
expire_time string No none
created_by string Yes read-only
created_time string Yes read-only
template string No none
is_answered boolean No read-only True if at least one party has answered. If this property is true and is_signed is false, the contract is rejected.
is_signed boolean No read-only True if all parties accepted the contract.
is_rejected boolean No read-only True if any of the parties rejected the contract.

ApiContractTemplate

{
    "self": "/api/contract_templates/3",
    "name": "string",
    "is_published": true,
    "header": "string",
    "content": "string",
    "footer": "string",
    "footer_type": "SIMPLE",
    "created_time": "2020-02-29 13:37:00",
    "updated_time": "2020-02-29 13:37:00",
    "created_by": "/api/users/15"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string Yes none
is_published boolean Yes none
header string No none HTML is allowed
content string Yes none HTML is allowed
footer string No none HTML is allowed. Can't be combined with a footer_type value of SIMPLE
footer_type string Yes none
enum, one of SIMPLE, ADVANCED
created_time string Yes read-only
updated_time string Yes read-only
created_by string No read-only

ApiCustomer

{
    "self": "/api/customers/15",
    "payment_option": "/api/payment_options/15",
    "identity_number": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "mobile_phone": "string",
    "visiting_address": "string",
    "visiting_zipcode": "string",
    "visiting_city": "string",
    "billing_address": "string",
    "billing_zipcode": "string",
    "billing_city": "string",
    "billing_email": "string",
    "billing_reference": "string",
    "created_time": "2020-02-29 13:37:00"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
payment_option string Yes none
identity_number string Yes none
name string Yes none
firstname string Yes none
lastname string Yes none
email string Yes none
mobile_phone string Yes none
visiting_address string No none
visiting_zipcode string No none
visiting_city string No none
billing_address string Yes none
billing_zipcode string Yes none
billing_city string Yes none
billing_email string No none
billing_reference string No none
created_time string Yes read-only

ApiCustomerCreate

{
    "self": "/api/customers/15",
    "payment_option": "/api/payment_options/15",
    "identity_number": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "mobile_phone": "string",
    "visiting_address": "string",
    "visiting_zipcode": "string",
    "visiting_city": "string",
    "billing_address": "string",
    "billing_zipcode": "string",
    "billing_city": "string",
    "billing_email": "string",
    "billing_reference": "string",
    "created_time": "2020-02-29 13:37:00",
    "user_active": true
}

Properties

Name Type Required Restrictions Description
self string No read-only
payment_option string No none
identity_number string No none
name string No none
firstname string No none
lastname string No none
email string No none
mobile_phone string No none
visiting_address string No none
visiting_zipcode string No none
visiting_city string No none
billing_address string No none
billing_zipcode string No none
billing_city string No none
billing_email string No none
billing_reference string No none
created_time string No read-only
user_active boolean Yes none True if user can log in

ApiCustomerSubscription

{
    "self": "/api/customers/9/subscriptions/10",
    "product": "/api/products/3",
    "price": 1,
    "valid_from_time": "2020-02-29 13:37:00",
    "valid_to_time": "2020-02-29 13:37:00",
    "cancelled_time": "2020-02-29 13:37:00",
    "notice_period": "string",
    "users_included": "string",
    "created_time": "2020-02-29 13:37:00"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
product string Yes none The product can't be changed when updating.
price number Yes read-only
valid_from_time string Yes none
valid_to_time string No none
cancelled_time string No read-only
notice_period integer No read-only
users_included integer No read-only
created_time string Yes read-only

ApiPaymentOption

{
    "self": "/api/payment_options/3",
    "name": "string",
    "price": 1,
    "vat": 1,
    "email_required": true
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string Yes none
price number Yes none
vat number Yes none
email_required boolean Yes none

ApiProduct

{
    "self": "/api/products/3",
    "name": "string",
    "type": "SUBSCRIPTION",
    "price": 1,
    "vat": 1,
    "unit": "string",
    "users_included": "string"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string Yes none
type string Yes none
enum, one of SUBSCRIPTION, USAGE, ADDON
price number Yes none
vat number Yes none
unit string Yes none
users_included integer Yes none

ApiToken

{
    "self": "/api/customers/15/api_tokens/104",
    "name": "string",
    "selector": "abcdef0123456789",
    "created_time": "2020-02-29 13:37:00"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
name string Yes none
selector string Yes none
created_time string Yes read-only

ApiTokenCreateResult

{
    "self": "/api/customers/15/api_tokens/104",
    "name": "string",
    "selector": "abcdef0123456789",
    "created_time": "2020-02-29 13:37:00",
    "cleartext_secret": "abcdef0123456789"
}

Properties

Name Type Required Restrictions Description
self string No read-only
name string No none
selector string No none
created_time string No read-only
cleartext_secret string Yes read-only

ApiUser

{
    "self": "/api/users/15",
    "permission_template": "CUSTOMER_ADMIN_USER",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "password": "string",
    "email": "string",
    "active": true,
    "created_time": "2020-02-29 13:37:00"
}

Properties

Name Type Required Restrictions Description
self string Yes read-only
permission_template string Yes none
enum, one of CUSTOMER_ADMIN_USER, CUSTOMER_USER
firstname string Yes none
lastname string Yes none
username string Yes none
password string No none
email string Yes none
active boolean No none True if user can log in
created_time string Yes read-only

JsonProblemResponse

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": "400",
    "detail": "string",
    "instance": "string"
}

Properties

Name Type Required Restrictions Description
type string Yes none Unique identifier of the problem, might be a link to the documentation
title string Yes none Short description about the problem
status integer Yes none The HTTP response code for the problem
detail string No none Longer description about the problem, might be in Swedish
instance string No none

Go to top