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 /contracts/{contract_id}/annotations

Code samples

GET /contracts/{contract_id}/annotations 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
`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": "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"
    }
]

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	Contract annotations	Array of ApiContractAnnotation
4XX	Error	JsonProblemResponse

Create a new contract annotation

POST /contracts/{contract_id}/annotations

Code samples

POST /contracts/{contract_id}/annotations 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

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

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

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 contract annotation	ApiContractAnnotation
4XX	Error	JsonProblemResponse

Authentication required

Authorization
Api-User-Uri

Get contract annotation

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

Code samples

GET /contracts/{contract_id}/annotations/{annotation_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
`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": "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"
}

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	Contract annotation	ApiContractAnnotation
4XX	Error	JsonProblemResponse

Update a contract annotation

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

Code samples

PUT /contracts/{contract_id}/annotations/{annotation_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

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

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

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 contract annotation	ApiContractAnnotation
4XX	Error	JsonProblemResponse

Authentication required

Authorization
Api-User-Uri

Delete contract annotation

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

Code samples

DELETE /contracts/{contract_id}/annotations/{annotation_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
`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"
}

Responses

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

Contract attachments

Get all contract attachments

GET /contracts/{contract_id}/attachments

Code samples

GET /contracts/{contract_id}/attachments 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
`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"
}

Responses

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

Create a new contract attachment

POST /contracts/{contract_id}/attachments

Code samples

POST /contracts/{contract_id}/attachments HTTP/1.1
Host: app.fastsign.se
Accept: application/json
Content-Type: application/octet-stream
Accept-Api-Version: 1
Content-Type: application/pdf
Content-Disposition: attachment; filename="my_attachment.pdf"
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
`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"
}

Responses

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

Authentication required

Authorization
Api-User-Uri

Get contract attachment

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

Code samples

GET /contracts/{contract_id}/attachments/{attachment_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
`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"
}

Responses

Status	Description	Schema
200	Contract attachment	ApiContractAttachment
4XX	Error	JsonProblemResponse

Delete contract attachment

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

Code samples

DELETE /contracts/{contract_id}/attachments/{attachment_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
`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"
}

Responses

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

Contract parties

Get all contract parties

GET /contracts/{contract_id}/parties

Code samples

GET /contracts/{contract_id}/parties 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
`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": "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"
    }
]

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	Contract parties	Array of ApiContractParty
4XX	Error	JsonProblemResponse

Create a new contract party

POST /contracts/{contract_id}/parties

Code samples

POST /contracts/{contract_id}/parties 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",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": "string",
    "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": "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"
}

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 contract party	ApiContractParty
4XX	Error	JsonProblemResponse

Authentication required

Authorization
Api-User-Uri

Get contract party

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

Code samples

GET /contracts/{contract_id}/parties/{party_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
`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": "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"
}

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	Contract party	ApiContractParty
4XX	Error	JsonProblemResponse

Update a contract party

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

Code samples

PUT /contracts/{contract_id}/parties/{party_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

{
    "name": "string",
    "email": "string",
    "mobile_phone": "string",
    "identity_number": "string",
    "delivery_method": "EMAIL",
    "sign_type": "DEFAULT",
    "sign_order": "string",
    "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": "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"
}

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 contract party	ApiContractParty
4XX	Error	JsonProblemResponse

Authentication required

Authorization
Api-User-Uri

Delete contract party

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

Code samples

DELETE /contracts/{contract_id}/parties/{party_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
`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"
}

Responses

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

Contract templates

Get all contract templates

GET /contract_templates

Code samples

GET /contract_templates 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/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"
}

Responses

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

Create a new contract template

POST /contract_templates

Code samples

POST /contract_templates 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",
    "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"
}

Responses

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

Get contract template

GET /contract_templates/{template_id}

Code samples

GET /contract_templates/{template_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
`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"
}

Responses

Status	Description	Schema
200	Contract template	ApiContractTemplate
4XX	Error	JsonProblemResponse

Update a contract template

PUT /contract_templates/{template_id}

Code samples

PUT /contract_templates/{template_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

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

Responses

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

Delete contract template

DELETE /contract_templates/{template_id}

Code samples

DELETE /contract_templates/{template_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
`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"
}

Responses

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

Contracts

Get all contracts

GET /contracts

Code samples

GET /contracts 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
`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",
        "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
    }
]

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	Contracts	Array of ApiContractSubset
4XX	Error	JsonProblemResponse

Create a new contract

POST /contracts

Code samples

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

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

POST /contracts 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

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

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 contract	ApiContract
4XX	Error	JsonProblemResponse

Authentication required

Authorization
Api-User-Uri

Get contract

GET /contracts/{contract_id}

Code samples

GET /contracts/{contract_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
`contract_id`	path	string	No	The contract ID

Example responses

200 response

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

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	Contract	ApiContract
4XX	Error	JsonProblemResponse

Update a contract

PUT /contracts/{contract_id}

Code samples

PUT /contracts/{contract_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

{
    "name": "string",
    "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",
    "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,
    "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"
        }
    ]
}

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 contract	ApiContract
4XX	Error	JsonProblemResponse

Authentication required

Authorization
Api-User-Uri

Delete contract

DELETE /contracts/{contract_id}

Code samples

DELETE /contracts/{contract_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
`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"
}

Responses

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

Send a contract

POST /contracts/{contract_id}/send

Code samples

POST /contracts/{contract_id}/send 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

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

Responses

Status	Description	Schema
200	No response
4XX	Error	JsonProblemResponse

Authentication required

Authorization

Retrieve the signed PDF

GET /contracts/{contract_id}/signed_pdf

Code samples

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

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

[]

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 signed contract PDF	string
4XX	Error	JsonProblemResponse

Users

Get all users

GET /users

Code samples

GET /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

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	Users	Array of ApiUser
4XX	Error	JsonProblemResponse

Create a new user

POST /users

Code samples

POST /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
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 user	ApiUser
4XX	Error	JsonProblemResponse

Get user

GET /users/{user_id}

Code samples

GET /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
`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	User	ApiUser
4XX	Error	JsonProblemResponse

Update a user

PUT /users/{user_id}

Code samples

PUT /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
`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 user	ApiUser
4XX	Error	JsonProblemResponse

Delete user

DELETE /users/{user_id}

Code samples

DELETE /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
`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 user was deleted
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,
    "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
`is_signed`	boolean	No	read-only
`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

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
`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;

setting the name property in conjunction with email or mobile_phone
setting the user_id property

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	Yes	read-only
`sign_time`	string	No	read-only
`reject_cause`	string	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.

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
}

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	Yes	read-only
`is_signed`	boolean	Yes	read-only

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
`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
`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
`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
`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
`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