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

Contract annotations

Get all contract annotations

GET /api/contracts/{contract_id}/annotations

Code samples

GET /api/contracts/{contract_id}/annotations HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

[
    {
        "self": "/api/contracts/85/annotations/86444",
        "party_id": "/api/contracts/85/parties/15",
        "pdf_page": 1,
        "pos_x": 1.42,
        "pos_y": 1.42,
        "width": 1.42,
        "height": 1.42,
        "type": "SIGNATURE",
        "content": "string",
        "input_required": true,
        "render_when_signed": true,
        "created_by": "/api/users/15",
        "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract annotations Array of ApiContractAnnotation
4XX Error JsonProblemResponse

Authentication required

Create a new contract annotation

POST /api/contracts/{contract_id}/annotations

Code samples

POST /api/contracts/{contract_id}/annotations HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "party_id": "/api/contracts/85/parties/15",
    "pdf_page": 1,
    "pos_x": 1.42,
    "pos_y": 1.42,
    "width": 1.42,
    "height": 1.42,
    "type": "SIGNATURE",
    "content": "string",
    "input_required": true,
    "render_when_signed": true
}

Parameters

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

Example responses

201 response

{
    "self": "/api/contracts/85/annotations/86444",
    "party_id": "/api/contracts/85/parties/15",
    "pdf_page": 1,
    "pos_x": 1.42,
    "pos_y": 1.42,
    "width": 1.42,
    "height": 1.42,
    "type": "SIGNATURE",
    "content": "string",
    "input_required": true,
    "render_when_signed": true,
    "created_by": "/api/users/15",
    "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
201 The newly created contract annotation ApiContractAnnotation
4XX Error JsonProblemResponse

Authentication required

Get contract annotation

GET /api/contracts/{contract_id}/annotations/{annotation_id}

Code samples

GET /api/contracts/{contract_id}/annotations/{annotation_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

{
    "self": "/api/contracts/85/annotations/86444",
    "party_id": "/api/contracts/85/parties/15",
    "pdf_page": 1,
    "pos_x": 1.42,
    "pos_y": 1.42,
    "width": 1.42,
    "height": 1.42,
    "type": "SIGNATURE",
    "content": "string",
    "input_required": true,
    "render_when_signed": true,
    "created_by": "/api/users/15",
    "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract annotation ApiContractAnnotation
4XX Error JsonProblemResponse

Authentication required

Update a contract annotation

PUT /api/contracts/{contract_id}/annotations/{annotation_id}

Code samples

PUT /api/contracts/{contract_id}/annotations/{annotation_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "party_id": "/api/contracts/85/parties/15",
    "pdf_page": 1,
    "pos_x": 1.42,
    "pos_y": 1.42,
    "width": 1.42,
    "height": 1.42,
    "type": "SIGNATURE",
    "content": "string",
    "input_required": true,
    "render_when_signed": 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
contract_id path string No The contract ID
annotation_id path string No The contract annotation ID
body body application/json
ApiContractAnnotation		 Yes

Example responses

200 response

{
    "self": "/api/contracts/85/annotations/86444",
    "party_id": "/api/contracts/85/parties/15",
    "pdf_page": 1,
    "pos_x": 1.42,
    "pos_y": 1.42,
    "width": 1.42,
    "height": 1.42,
    "type": "SIGNATURE",
    "content": "string",
    "input_required": true,
    "render_when_signed": true,
    "created_by": "/api/users/15",
    "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 The updated contract annotation ApiContractAnnotation
4XX Error JsonProblemResponse

Authentication required

Delete contract annotation

DELETE /api/contracts/{contract_id}/annotations/{annotation_id}

Code samples

DELETE /api/contracts/{contract_id}/annotations/{annotation_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
contract_id path string No The contract ID
annotation_id path string No The contract annotation 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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
204 Empty result if the contract annotation was deleted
4XX Error JsonProblemResponse

Authentication required

Contract attachments

Get all contract attachments

GET /api/contracts/{contract_id}/attachments

Code samples

GET /api/contracts/{contract_id}/attachments HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

[
    {
        "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"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract attachments Array of ApiContractAttachment
4XX Error JsonProblemResponse

Authentication required

Create a new contract attachment

POST /api/contracts/{contract_id}/attachments

Code samples

POST /api/contracts/{contract_id}/attachments HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/pdf
Content-Disposition: attachment; filename="my_attachment.pdf"
Authorization: token {access-token}
Api-User-Uri: API_KEY

string

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
contract_id path string No The contract ID
Content-Type header string Yes Attachment content type
Content-Disposition header string Yes Attachment disposition containing the filename
body body application/octet-stream
string (binary)		 Yes Attachment data, can be max 2 MiB

Example responses

201 response

{
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
201 The newly created contract attachment ApiContractAttachment
4XX Error JsonProblemResponse

Authentication required

Get contract attachment

GET /api/contracts/{contract_id}/attachments/{attachment_id}

Code samples

GET /api/contracts/{contract_id}/attachments/{attachment_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

{
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract attachment ApiContractAttachment
4XX Error JsonProblemResponse

Authentication required

Delete contract attachment

DELETE /api/contracts/{contract_id}/attachments/{attachment_id}

Code samples

DELETE /api/contracts/{contract_id}/attachments/{attachment_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
contract_id path string No The contract ID
attachment_id path string No The contract attachment 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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
204 Empty result if the contract attachment was deleted
4XX Error JsonProblemResponse

Authentication required

Contract parties

Get all contract parties

GET /api/contracts/{contract_id}/parties

Code samples

GET /api/contracts/{contract_id}/parties HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

[
    {
        "self": "/api/contracts/85/parties/452",
        "name": "string",
        "email": "string",
        "mobile_phone": "string",
        "identity_number": "string",
        "delivery_method": "EMAIL",
        "sign_type": "DEFAULT",
        "sign_order": 1,
        "is_accept": true,
        "sign_time": "2020-02-29 13:37:00",
        "reject_cause": "string",
        "email_status": {
            "sent": true,
            "opened": true,
            "clicked": true,
            "bounced": true,
            "hardbounced": true,
            "softbounced": true,
            "blocked": true,
            "unsub": true,
            "spam": true
        },
        "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"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract parties Array of ApiContractParty
4XX Error JsonProblemResponse

Authentication required

Create a new contract party

POST /api/contracts/{contract_id}/parties

Code samples

POST /api/contracts/{contract_id}/parties HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": 1,
    "user": "/api/users/15"
}

Parameters

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

Example responses

201 response

{
    "self": "/api/contracts/85/parties/452",
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": 1,
    "is_accept": true,
    "sign_time": "2020-02-29 13:37:00",
    "reject_cause": "string",
    "email_status": {
        "sent": true,
        "opened": true,
        "clicked": true,
        "bounced": true,
        "hardbounced": true,
        "softbounced": true,
        "blocked": true,
        "unsub": true,
        "spam": true
    },
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
201 The newly created contract party ApiContractParty
4XX Error JsonProblemResponse

Authentication required

Get contract party

GET /api/contracts/{contract_id}/parties/{party_id}

Code samples

GET /api/contracts/{contract_id}/parties/{party_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

{
    "self": "/api/contracts/85/parties/452",
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": 1,
    "is_accept": true,
    "sign_time": "2020-02-29 13:37:00",
    "reject_cause": "string",
    "email_status": {
        "sent": true,
        "opened": true,
        "clicked": true,
        "bounced": true,
        "hardbounced": true,
        "softbounced": true,
        "blocked": true,
        "unsub": true,
        "spam": true
    },
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract party ApiContractParty
4XX Error JsonProblemResponse

Authentication required

Update a contract party

PUT /api/contracts/{contract_id}/parties/{party_id}

Code samples

PUT /api/contracts/{contract_id}/parties/{party_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": 1,
    "user": "/api/users/15"
}

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
contract_id path string No The contract ID
party_id path string No The contract party ID
body body application/json
ApiContractParty		 Yes

Example responses

200 response

{
    "self": "/api/contracts/85/parties/452",
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": 1,
    "is_accept": true,
    "sign_time": "2020-02-29 13:37:00",
    "reject_cause": "string",
    "email_status": {
        "sent": true,
        "opened": true,
        "clicked": true,
        "bounced": true,
        "hardbounced": true,
        "softbounced": true,
        "blocked": true,
        "unsub": true,
        "spam": true
    },
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 The updated contract party ApiContractParty
4XX Error JsonProblemResponse

Authentication required

Delete contract party

DELETE /api/contracts/{contract_id}/parties/{party_id}

Code samples

DELETE /api/contracts/{contract_id}/parties/{party_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
contract_id path string No The contract ID
party_id path string No The contract party 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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
204 Empty result if the contract party was deleted
4XX Error JsonProblemResponse

Authentication required

Contract templates

Get all contract templates

GET /api/contract_templates

Code samples

GET /api/contract_templates HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

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/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"
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract templates Array of ApiContractTemplate
4XX Error JsonProblemResponse

Authentication required

Create a new contract template

POST /api/contract_templates

Code samples

POST /api/contract_templates HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}

{
    "name": "string",
    "is_published": true,
    "header": "string",
    "content": "string",
    "footer": "string",
    "footer_type": "SIMPLE"
}

Parameters

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

Example responses

201 response

{
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
201 The newly created template ApiContractTemplate
4XX Error JsonProblemResponse

Authentication required

Get contract template

GET /api/contract_templates/{template_id}

Code samples

GET /api/contract_templates/{template_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

{
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract template ApiContractTemplate
4XX Error JsonProblemResponse

Authentication required

Update a contract template

PUT /api/contract_templates/{template_id}

Code samples

PUT /api/contract_templates/{template_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}

{
    "name": "string",
    "is_published": true,
    "header": "string",
    "content": "string",
    "footer": "string",
    "footer_type": "SIMPLE"
}

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
template_id path string No The template ID
body body application/json
ApiContractTemplate		 Yes

Example responses

200 response

{
    "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"
}

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 The updated contract template ApiContractTemplate
4XX Error JsonProblemResponse

Authentication required

Delete contract template

DELETE /api/contract_templates/{template_id}

Code samples

DELETE /api/contract_templates/{template_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
template_id path string No The template 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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

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

Authentication required

Contracts

Get all contracts

GET /api/contracts

Code samples

GET /api/contracts HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
status query
enum, one of draft, sent, signed, rejected		 No Filter by status
user query string No Filter by user (author)
name query string No Search by name
page query string No Sets page
sort query string
enum, one of id, name, is_signed, updated_time		 No Specifies sort direction for result, comma separated

Example responses

200 response

[
    {
        "self": "/api/contracts/85",
        "name": "string",
        "language": "en",
        "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
    }
]

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contracts Array of ApiContractSubset
4XX Error JsonProblemResponse

Authentication required

Create a new contract

POST /api/contracts

Code samples

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

%PDF-1.4
3 0 obj
<</Type /Page
/Parent 1 0 R

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

{
    "template": "/api/contract_templates/3"
}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
body body application/pdf
string (binary)		 Yes Either a complete PDF in binary form (max 2 MiB) or JSON body with property template
body body application/json
object		 Yes Either a complete PDF in binary form (max 2 MiB) or JSON body with property template
» template body string No

Example responses

201 response

{
    "self": "/api/contracts/85",
    "name": "string",
    "language": "en",
    "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": 1,
            "is_accept": true,
            "sign_time": "2020-02-29 13:37:00",
            "reject_cause": "string",
            "email_status": {
                "sent": true,
                "opened": true,
                "clicked": true,
                "bounced": true,
                "hardbounced": true,
                "softbounced": true,
                "blocked": true,
                "unsub": true,
                "spam": true
            },
            "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": 1,
            "pos_x": 1.42,
            "pos_y": 1.42,
            "width": 1.42,
            "height": 1.42,
            "type": "SIGNATURE",
            "content": "string",
            "input_required": true,
            "render_when_signed": true,
            "created_by": "/api/users/15",
            "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
201 The newly created contract ApiContract
4XX Error JsonProblemResponse

Authentication required

Get contract

GET /api/contracts/{contract_id}

Code samples

GET /api/contracts/{contract_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

{
    "self": "/api/contracts/85",
    "name": "string",
    "language": "en",
    "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": 1,
            "is_accept": true,
            "sign_time": "2020-02-29 13:37:00",
            "reject_cause": "string",
            "email_status": {
                "sent": true,
                "opened": true,
                "clicked": true,
                "bounced": true,
                "hardbounced": true,
                "softbounced": true,
                "blocked": true,
                "unsub": true,
                "spam": true
            },
            "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": 1,
            "pos_x": 1.42,
            "pos_y": 1.42,
            "width": 1.42,
            "height": 1.42,
            "type": "SIGNATURE",
            "content": "string",
            "input_required": true,
            "render_when_signed": true,
            "created_by": "/api/users/15",
            "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Contract ApiContract
4XX Error JsonProblemResponse

Authentication required

Update a contract

PUT /api/contracts/{contract_id}

Code samples

PUT /api/contracts/{contract_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}
Api-User-Uri: API_KEY

{
    "name": "string",
    "language": "en",
    "content": "string",
    "email_invite_content": "string",
    "email_from_name": "string",
    "email_reply_to": "string",
    "party_order_defined": true,
    "show_identity_number": true,
    "require_auth": "NONE",
    "expire_time": "2020-02-29 13:37:00",
    "template": "/api/contract_templates/3"
}

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
contract_id path string No The contract ID
body body application/json
ApiContract		 Yes

Example responses

200 response

{
    "self": "/api/contracts/85",
    "name": "string",
    "language": "en",
    "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": 1,
            "is_accept": true,
            "sign_time": "2020-02-29 13:37:00",
            "reject_cause": "string",
            "email_status": {
                "sent": true,
                "opened": true,
                "clicked": true,
                "bounced": true,
                "hardbounced": true,
                "softbounced": true,
                "blocked": true,
                "unsub": true,
                "spam": true
            },
            "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": 1,
            "pos_x": 1.42,
            "pos_y": 1.42,
            "width": 1.42,
            "height": 1.42,
            "type": "SIGNATURE",
            "content": "string",
            "input_required": true,
            "render_when_signed": true,
            "created_by": "/api/users/15",
            "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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 The updated contract ApiContract
4XX Error JsonProblemResponse

Authentication required

Delete contract

DELETE /api/contracts/{contract_id}

Code samples

DELETE /api/contracts/{contract_id} HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
contract_id path string No The contract 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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

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

Authentication required

Send a contract

POST /api/contracts/{contract_id}/send

Code samples

POST /api/contracts/{contract_id}/send HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Content-Type: application/json
Authorization: token {access-token}

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

This makes the contract read-only. Calling any POST, PUT or DELETE methods on the contract endpoints will fail.

Parameters

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

Example responses

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 No response
4XX Error JsonProblemResponse

Authentication required

Retrieve the signed PDF

GET /api/contracts/{contract_id}/signed_pdf

Code samples

GET /api/contracts/{contract_id}/signed_pdf HTTP/1.1
Host: app.fastsign.se
Accept: application/pdf
Accept-Api-Version: 1
Authorization: token {access-token}

This is only available if the PDF is signed by all parties.

Parameters

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

Example responses

200 response

string

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 The signed contract PDF string
4XX Error JsonProblemResponse

Authentication required

Get the contract activity log

GET /api/contracts/{contract_id}/activity_log

Code samples

GET /api/contracts/{contract_id}/activity_log HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

Parameters

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

Example responses

200 response

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

4XX response

{
    "type": "https://app.fastsign.se/apidoc/v1/posting_data#malformed-json",
    "title": "Malformed JSON",
    "status": 400,
    "detail": "string",
    "instance": "string",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 The activity log Array of ApiContractActivityLog
4XX Error JsonProblemResponse

Authentication required

Users

Get all users

GET /api/users

Code samples

GET /api/users HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Accept-Api-Version: 1
Authorization: token {access-token}

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/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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 Users Array of ApiUser
4XX Error JsonProblemResponse

Authentication required

Create a new user

POST /api/users

Code samples

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

{
    "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
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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

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

Authentication required

Get user

GET /api/users/{user_id}

Code samples

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

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

Status Description Schema
200 User ApiUser
4XX Error JsonProblemResponse

Authentication required

Update a user

PUT /api/users/{user_id}

Code samples

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

{
    "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
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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

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

Authentication required

Delete user

DELETE /api/users/{user_id}

Code samples

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

Parameters

Name In Type Required Description
Accept-Api-Version header integer Yes Specifies which version of this API is requested
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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

Responses

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

Authentication required

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",
    "language": "en",
    "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": 1,
            "is_accept": true,
            "sign_time": "2020-02-29 13:37:00",
            "reject_cause": "string",
            "email_status": {
                "sent": true,
                "opened": true,
                "clicked": true,
                "bounced": true,
                "hardbounced": true,
                "softbounced": true,
                "blocked": true,
                "unsub": true,
                "spam": true
            },
            "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": 1,
            "pos_x": 1.42,
            "pos_y": 1.42,
            "width": 1.42,
            "height": 1.42,
            "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
name string Yes none
language string No none The language to use in contract sign interface, using ISO standard 639-1. If this is left empty, the language from customer will be copied.
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.
parties Array of ApiContractParty No none A party can be created in two ways;
* setting the name property in conjunction with email or mobile_phone
* setting the user property
annotations Array of ApiContractAnnotation No 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": 1,
    "pos_x": 1.42,
    "pos_y": 1.42,
    "width": 1.42,
    "height": 1.42,
    "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": 1,
    "is_accept": true,
    "sign_time": "2020-02-29 13:37:00",
    "reject_cause": "string",
    "email_status": {
        "sent": true,
        "opened": true,
        "clicked": true,
        "bounced": true,
        "hardbounced": true,
        "softbounced": true,
        "blocked": true,
        "unsub": true,
        "spam": true
    },
    "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, NONE		 Decides which communication channel should be used for sending sign invitations and
further status updates about the contract to this party. Setting this to NONE will prohibit any
automatic sending of e-mail or SMS to the party.
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 read-only
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",
    "language": "en",
    "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
language string No none The language to use in contract sign interface, using ISO standard 639-1. If this is left empty, the language from customer will be copied.
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",
    "language": "en",
    "identity_number": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "mobile_phone": "string",
    "country": "SE",
    "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
language string No none The language to use in contract sign interface, using ISO standard 639-1.
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
country string No none The country of operation using ISO standard 3166-1 alpha-2
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",
    "language": "en",
    "identity_number": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "email": "string",
    "mobile_phone": "string",
    "country": "SE",
    "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 Yes read-only
payment_option string Yes none
language string No none The language to use in contract sign interface, using ISO standard 639-1.
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
country string No none The country of operation using ISO standard 3166-1 alpha-2
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
user_active boolean No none True if user can log in

ApiCustomerSubscription

{
    "self": "/api/customers/9/subscriptions/10",
    "product": "/api/products/3",
    "price": 1.42,
    "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": 1,
    "users_included": 1,
    "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.42,
    "vat": 1.42,
    "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.42,
    "vat": 1.42,
    "unit": "string",
    "users_included": 1
}

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 read-only
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 Yes read-only
name string Yes none
selector string Yes read-only
created_time string Yes read-only
cleartext_secret string No 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",
    "validation_errors": [
        "The given value is invalid."
    ]
}

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
validation_errors Array of string No none List of detailed validation errors. If any required keys in the request are missing,
this is a list of missing key names. If all required keys are set but their values doesn't validate,
a user friendly Swedish string is given.

Go to top