Adding an expected signer

To add a signer to the document, send a POST request to https://digidoc.1dox.site/api/addexpectedsigner

Request body parameters

Name	Type	Example	Description	Required?
document_oid	number	10001010	System file oid	Yes
id_code	string	48010100567	The national id-code of the expected signer Note: currently only id-codes already present in the system are supported	Yes
first_name	string	Mari	First name of the expected signer Note: currently not used	No
last_name	string	Tamm	Last name of the expected signer. Note: currently not used	No
role	string	Juhataja	Role of the expected signer.	No

Example request

curl -L -X POST 'https://digidoc.1dox.site/api/addexpectedsigner\
-H 'X-API-Key: <your api key>' \
--data-raw '{                       
    "document_oid": 10004620,
    "first_name": "Mari	",
    "last_name": "Tamm",
    "id_code": 48010100567,
    "role": "Juhataja"
}'

Response

Name	Type	Example	Description
status	number	1	Request status 1 – OK 2 – error
statusmessage	string	OK	Request status as a string message
error	string	ID-code not found in system.	Only for request status 2, an error message is returned

Example successful response

{
    "status": 1,
    "statusmessage": "OK"
}

Example error response

{
    "status": 2,
    "error": "ID-code not found in system"
}