container-signature-services (24.3.0.8)
Download OpenAPI specification:Download
signPDFSmartId
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
startPDFSign
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureReason | string |
signatureContactInfo | string |
label | string |
pdfSignatureIsVisible | boolean |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "string",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "label": "string",
- "pdfSignatureIsVisible": true
}
startDocumentSign
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureReason | string |
signatureContactInfo | string |
label | string |
pdfSignatureIsVisible | boolean |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "string",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "label": "string",
- "pdfSignatureIsVisible": true
}
startContainerSign
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signXades
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
signXades_1
path Parameters
signatureLevel required | string |
signaturePackaging required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
signPDF
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signPDF_1
path Parameters
id required | string |
instantsession required | boolean |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument
path Parameters
id required | string |
instantsession required | boolean |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_1
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_2
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
instantsession required | boolean |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
instantsession required | boolean |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing certificate
Get Smart-ID signing certificate for hash signing
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
"string"
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing certificate
Get Smart-ID signing certificate for hash signing
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing process status
Get Smart-ID signing process status using poll or waite till result mechanism
path Parameters
session required | string Example: 9f68c94e-086e-461d-9cda-6a919c9ed603 Session code from signing initiation request response |
pollwaitinmilliseconds required | integer <int64> Example: 90000 Poll wait in milliseconds. Long waite enabled if exists and is positive number. In case of missing parameter, 0 or negative value immediate poll response. |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing process status
Get Smart-ID signing process status using poll or waite till result mechanism
path Parameters
session required | string Example: 9f68c94e-086e-461d-9cda-6a919c9ed603 Session code from signing initiation request response |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
signPDF_2
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_3
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signMobileIdContainer
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing process status
Get Smart-ID signing process status using poll or waite till result mechanism
path Parameters
session required | string Example: 9f68c94e-086e-461d-9cda-6a919c9ed603 Session code from signing initiation request response |
pollwaitinmilliseconds required | integer <int64> Example: 90000 Poll wait in milliseconds. Long waite enabled if exists and is positive number In case of missing parameter, 0 or negative value immediate poll response. |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing process status
Get Smart-ID signing process status using poll or waite till result mechanism
path Parameters
session required | string Example: 9f68c94e-086e-461d-9cda-6a919c9ed603 Session code from signing initiation request response |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
signPDF_3
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_4
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
Request Body schema: application/jsonrequired
idCode required | string Example: "390101-00001" Person personal code |
displayText | string Example: "Please sign document" Message displayed to the user to prompt them to authorize. Up to 300 characters of text. |
forcePin | boolean Example: "false" Request to use PIN code, biometrics not allowed. |
Responses
Request samples
- Payload
{- "displayText": "Please sign document",
- "forcePin": false,
- "idCode": "390101-00001"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
Request Body schema: application/jsonrequired
idCode required | string Example: "390101-00001" Person personal code |
displayText | string Example: "Please sign document" Message displayed to the user to prompt them to authorize. Up to 300 characters of text. |
forcePin | boolean Example: "false" Request to use PIN code, biometrics not allowed. |
Responses
Request samples
- Payload
{- "displayText": "Please sign document",
- "forcePin": false,
- "idCode": "390101-00001"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
signPdf
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_6
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signPdf_1
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
E-Seal pdf document
E-Seal pdf document in archive referenced by id from request. For visual signature specify 'pdfSigningSigner' parameter value according to pdfSigningSigner schema.
path Parameters
id required | string |
company required | string |
query Parameters
pdfSigningSigner | string |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "callBackUrl": "string",
- "documentID": "string",
- "verificationCode": "string",
- "errorMessage": "string",
- "signatureProfile": "string",
- "container": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
E-Seal ASICE container.
E-Seal ASICE container created from file(s) provided by request.
path Parameters
company required | string |
query Parameters
fileName | Array of strings |
containerName | string |
signatureProfile | string |
Request Body schema: */*
file required | Array of strings <binary> [ items <binary > ] |
Responses
E-Seal ASIC document.
E-Seal asic container reference provided by request. If referenced document is not ASICE container, create one from document referenced
path Parameters
id required | string |
company required | string |
query Parameters
signatureProfile | string |
Request Body schema: application/json
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "callBackUrl": "string",
- "documentID": "string",
- "verificationCode": "string",
- "errorMessage": "string",
- "signatureProfile": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
E-Seal ASICE container.
E-Seal ASICE container reference provided by request.
path Parameters
id required | string |
company required | string |
query Parameters
signatureProfile | string |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "callBackUrl": "string",
- "documentID": "string",
- "verificationCode": "string",
- "errorMessage": "string",
- "signatureProfile": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
generateHashForExistingEndpoint
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
getAuthenticationResult
path Parameters
provider required | string |
query Parameters
state required | string |
code required | string |
Responses
Response samples
- 200
{- "sessionId": "string",
- "name": "string",
- "givenName": "string",
- "familyName": "string",
- "serialNumber": "string",
- "eips": "string"
}
signPdfDocument
path Parameters
provider required | string |
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_7
path Parameters
provider required | string |
id required | string |
Request Body schema: application/json
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signBatch
path Parameters
provider required | string |
Request Body schema: application/jsonrequired
documents required | Array of strings |
object (PDFSigningSigner) |
Responses
Request samples
- Payload
{- "documents": [
- "string"
], - "pdfSigner": {
- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
}
signPdf_2
path Parameters
id required | string |
query Parameters
locale | string Default: "" |
signatureProfile | string Default: "LT" |
role | string Default: "" |
additionalData | string |
authRedirectUri | string Default: "" |
signRedirectUri | string Default: "" |
state | string Default: "" |
Request Body schema: application/json
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signDocument_8
path Parameters
id required | string |
query Parameters
locale | string Default: "" |
signatureProfile | string Default: "LT" |
role | string Default: "" |
additionalData | string |
authRedirectUri | string Default: "" |
signRedirectUri | string Default: "" |
state | string Default: "" |
Request Body schema: application/json
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
signBatch_1
query Parameters
locale | string Default: "" |
signatureProfile | string Default: "LT" |
role | string Default: "" |
additionalData | string |
authRedirectUri | string Default: "" |
signRedirectUri | string Default: "" |
state | string Default: "" |
Request Body schema: application/jsonrequired
documents required | Array of strings |
object (PDFSigningSigner) |
Responses
Request samples
- Payload
{- "documents": [
- "string"
], - "pdfSigner": {
- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
}
generateHashForPDFExistingEndpoint
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
generateHashForPDFExistingEndpointDSS
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
generateHashDocument
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
Forward OCSP request to vendor
Froward OCSP bytearray request to TSP
Request Body schema: application/jsonrequired
signingCertificate | string |
issuerCertificate | string |
extnId | string |
extnValue | string |
critical | boolean |
object (Extension) | |
object (CertificateToken) | |
object (CertificateToken) |
Responses
Request samples
- Payload
{- "signingCertificate": "string",
- "issuerCertificate": "string",
- "extnId": "string",
- "extnValue": "string",
- "critical": true,
- "nonceExtension": {
- "extnId": {
- "id": "string",
- "encoded": "string"
}, - "critical": true,
- "extnValue": {
- "octets": "string",
- "octetStream": { },
- "loadedObject": {
- "encoded": "string"
}, - "encoded": "string"
}, - "parsedValue": { },
- "encoded": "string"
}, - "issuerCertificateToken": {
- "publicKeyOfTheSigner": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}, - "signatureValidity": "VALID",
- "signatureAlgorithm": "RSA_RAW",
- "entityKey": { },
- "selfSigned": true,
- "keyUsageBits": [
- "DIGITAL_SIGNATURE"
], - "sourceURL": "string",
- "creationDate": "2019-08-24T14:15:22Z",
- "subject": {
- "principal": {
- "name": "string",
- "encoded": "string"
}, - "encoded": "string",
- "canonical": "string",
- "rfc2253": "string",
- "prettyPrintRFC2253": "string"
}, - "issuer": {
- "principal": {
- "name": "string",
- "encoded": "string"
}, - "encoded": "string",
- "canonical": "string",
- "rfc2253": "string",
- "prettyPrintRFC2253": "string"
}, - "notBefore": "2019-08-24T14:15:22Z",
- "selfIssued": true,
- "signature": "string",
- "encoded": "string",
- "publicKey": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}, - "issuerX500Principal": {
- "name": "string",
- "encoded": "string"
}, - "serialNumber": 0,
- "notAfter": "2019-08-24T14:15:22Z",
- "ca": true,
- "abbreviation": "string",
- "pathLenConstraint": 0,
- "certificate": {
- "keyUsage": [
- true
], - "sigAlgParams": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "extendedKeyUsage": [
- "string"
], - "subjectDN": {
- "name": "string"
}, - "issuerDN": {
- "name": "string"
}, - "tbscertificate": "string",
- "sigAlgName": "string",
- "sigAlgOID": "string",
- "issuerUniqueID": [
- true
], - "subjectUniqueID": [
- true
], - "subjectAlternativeNames": [
- [
- { }
]
], - "issuerAlternativeNames": [
- [
- { }
]
], - "signature": "string",
- "basicConstraints": 0,
- "issuerX500Principal": {
- "name": "string",
- "encoded": "string"
}, - "subjectX500Principal": {
- "name": "string",
- "encoded": "string"
}, - "version": 0,
- "serialNumber": 0,
- "notAfter": "2019-08-24T14:15:22Z",
- "criticalExtensionOIDs": [
- "string"
], - "nonCriticalExtensionOIDs": [
- "string"
], - "type": "string",
- "encoded": "string",
- "publicKey": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}
}, - "valid": true,
- "dssid": {
- "binaries": "string"
}, - "dssidAsString": "string",
- "signatureIntact": true,
- "invalidityReason": "string"
}, - "signingCertificateToken": {
- "publicKeyOfTheSigner": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}, - "signatureValidity": "VALID",
- "signatureAlgorithm": "RSA_RAW",
- "entityKey": { },
- "selfSigned": true,
- "keyUsageBits": [
- "DIGITAL_SIGNATURE"
], - "sourceURL": "string",
- "creationDate": "2019-08-24T14:15:22Z",
- "subject": {
- "principal": {
- "name": "string",
- "encoded": "string"
}, - "encoded": "string",
- "canonical": "string",
- "rfc2253": "string",
- "prettyPrintRFC2253": "string"
}, - "issuer": {
- "principal": {
- "name": "string",
- "encoded": "string"
}, - "encoded": "string",
- "canonical": "string",
- "rfc2253": "string",
- "prettyPrintRFC2253": "string"
}, - "notBefore": "2019-08-24T14:15:22Z",
- "selfIssued": true,
- "signature": "string",
- "encoded": "string",
- "publicKey": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}, - "issuerX500Principal": {
- "name": "string",
- "encoded": "string"
}, - "serialNumber": 0,
- "notAfter": "2019-08-24T14:15:22Z",
- "ca": true,
- "abbreviation": "string",
- "pathLenConstraint": 0,
- "certificate": {
- "keyUsage": [
- true
], - "sigAlgParams": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "extendedKeyUsage": [
- "string"
], - "subjectDN": {
- "name": "string"
}, - "issuerDN": {
- "name": "string"
}, - "tbscertificate": "string",
- "sigAlgName": "string",
- "sigAlgOID": "string",
- "issuerUniqueID": [
- true
], - "subjectUniqueID": [
- true
], - "subjectAlternativeNames": [
- [
- { }
]
], - "issuerAlternativeNames": [
- [
- { }
]
], - "signature": "string",
- "basicConstraints": 0,
- "issuerX500Principal": {
- "name": "string",
- "encoded": "string"
}, - "subjectX500Principal": {
- "name": "string",
- "encoded": "string"
}, - "version": 0,
- "serialNumber": 0,
- "notAfter": "2019-08-24T14:15:22Z",
- "criticalExtensionOIDs": [
- "string"
], - "nonCriticalExtensionOIDs": [
- "string"
], - "type": "string",
- "encoded": "string",
- "publicKey": {
- "encoded": "string",
- "format": "string",
- "algorithm": "string"
}
}, - "valid": true,
- "dssid": {
- "binaries": "string"
}, - "dssidAsString": "string",
- "signatureIntact": true,
- "invalidityReason": "string"
}
}
E-Seal Document using profile
E-Seal Document using profile by ID provided by request.
path Parameters
id required | string |
profile required | string |
Request Body schema: application/json
phoneNo | string Example: "+3721234567890" Mobile number for Mobile-ID (EE, LT). Starting with country code staring with '+' |
idCode | string Example: "3621234567890" Personal code for Smart-ID (EE, LV, LT) |
country | string Example: "EE" Country code for singing with Mobile-ID (EE, LT), Smart-ID (EE,LV, LT). Country code in format LV, LT, EE |
documentNumber | string Example: "123123123123" Smart-ID document number used for signing identified during authentication process |
displayText | string Example: "Please sign document" Smart-ID display text (can be longer text if user has new version of Smart-ID mobile App). If not specified used 'displayText' |
role | string Example: "CEO of Company" Signer role added to xades signatures (asice containers) |
delay | integer <int32> Example: "3000" Smart-ID app popup delay in milliseconds between returning verification code |
callbackUrl | string Example: "3000" Callback url to send process information. Replacements for {documentid}, {sessioncode}, {status} tags performed |
hashToSign | string Internal use only |
signatureProfile | string Example: "PAdES_BASELINE_LT" |
certInHex | string Certificate in HEX format to use for ID-card signing |
fileToSign | string Files to sign for remote hash signing |
signatureLocation | string Example: "Tallinn, Estonia" PDF signature location attribute value |
signatureReason | string Example: "Apporve" PDF signature reason attribute value |
signatureContactInfo | string Example: "signer@trustlynx.com" PDF signature contact info attribute value |
pdfSignatureIsVisible | boolean Example: "true" Add PDF signature visual representation or not |
forcePin | boolean Example: "false" Force confirm eparaksts mobile signing by pin |
font | string Example: "classpath:OpenSansRegular.ttf" Signature text font. Reference as available resource to application |
signerTextVerticalPosition | string Example: "BOTTOM" Signature text positioning, possible values: TOP, BOTTOM RIGHT, LEFT |
signatureImageScaling | string Example: "ZOOM_AND_CENTER" Signature image scaling, possible values: STRETCH, ZOOM_AND_CENTER, CENTER |
signatureFieldHeight | integer <int32> Example: "100" Visual signature field height |
signatureFieldWidth | integer <int32> Example: "200" Visual signature field width |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signingInfo | object |
documentName | string |
phoneNumber | string |
personCode | string |
pin | string |
Responses
Request samples
- Payload
{- "phoneNo": "+3721234567890",
- "idCode": "3621234567890",
- "country": "EE",
- "documentNumber": "123123123123",
- "displayText": "Please sign document",
- "role": "CEO of Company",
- "delay": 3000,
- "callbackUrl": "3000",
- "hashToSign": "string",
- "signatureProfile": "PAdES_BASELINE_LT",
- "certInHex": "string",
- "fileToSign": "string",
- "signatureLocation": "Tallinn, Estonia",
- "signatureReason": "Apporve",
- "signatureContactInfo": "signer@trustlynx.com",
- "pdfSignatureIsVisible": true,
- "forcePin": false,
- "font": "classpath:OpenSansRegular.ttf",
- "signerTextVerticalPosition": "BOTTOM",
- "signatureImageScaling": "ZOOM_AND_CENTER",
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "pdfSignatureVisuals": {
- "signatureImage": "Digitally signed by: {g} {sn} \\nAt date: {date}",
- "signatureXAxis": 100,
- "signatureYAxis": 100,
- "signatureZoom": 50,
- "signaturePage": 1,
- "sigMod2XIndent": 250,
- "signatureFieldHeight": 100,
- "signatureFieldWidth": 200,
- "textBackgroundColor": "#FF0096",
- "imageBackgroundColor": "#FF0096",
- "signatureTimeZone": "Europe/Tallinn",
- "numberOfSignaturesInRow": 0
}, - "pdfAdditionalText": {
- "text": "This document is digitally signed",
- "page": 1,
- "x": 100,
- "font": "classpath:OpenSansRegular.ttf",
- "fontSize": 12,
- "colour": "\"colour\": {\n \"r\": 0,\n \"g\": 0,\n \"b\": 0\n }",
- "transparency": 0.5
}, - "label": "string",
- "signingInfo": { },
- "documentName": "string",
- "phoneNumber": "string",
- "personCode": "string",
- "pin": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "callBackUrl": "string",
- "documentID": "string",
- "verificationCode": "string",
- "errorMessage": "string",
- "signatureProfile": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
encryptFileSerials
query Parameters
ldapProfile required | string Ldap profile |
filters required | Array of strings Recipient filters |
containerName | string Cdoc container name |
Request Body schema: multipart/form-data
file required | Array of strings <binary> [ items <binary > ] Files to be added to container |
Responses
createContainerSerials
query Parameters
documentData required | string DocumentData |
ldapProfile required | string Ldap profile |
filters required | Array of strings Recipient filters |
Request Body schema: multipart/form-data
file required | Array of strings <binary> [ items <binary > ] Files to be added to container |
Responses
getDocumentSignatures
path Parameters
profile required | string |
Request Body schema: multipart/form-data
file required | string <binary> |
Responses
Response samples
- 200
{- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "documentMimeType": "string",
- "objectName": "string",
- "valid": true
}
getDocumentSignatures_1
Request Body schema: multipart/form-data
file required | string <binary> |
Responses
Response samples
- 200
{- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "documentMimeType": "string",
- "objectName": "string",
- "valid": true
}
getDocumentSignatures_2
Request Body schema: multipart/form-data
file required | string <binary> |
Responses
Response samples
- 200
{- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "documentMimeType": "string",
- "objectName": "string",
- "valid": true
}
Request samples
- Payload
"string"
Response samples
- 200
{- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
createContainerFromDocuments_1
Request Body schema: application/jsonrequired
documentId | string |
newDocumentName | string |
Array of objects (DocumentIdNamePair) |
Responses
Request samples
- Payload
{- "documentId": "string",
- "newDocumentName": "string",
- "containerDocuments": [
- {
- "documentId": "string",
- "fileName": "string"
}
]
}
Add file to container.
Add file to existing container file(s) provided by request.
query Parameters
fileName | Array of strings File names if attached file original name will be replaced |
Request Body schema: multipart/form-data
container required | string <binary> Container files will be added to |
file required | Array of strings <binary> [ items <binary > ] Files to be added to container |
Responses
Extend CaDES signature.
Extend CaDES signature to level T, LT or LTA
Request Body schema: application/jsonrequired
messageDigestDigestAlgorithmName | string |
messageDigestInHex | string |
cmssSignatureInHex | string |
signatureLevel | string |
signingTime | integer <int64> |
certificateInHex | string |
Responses
Request samples
- Payload
{- "messageDigestDigestAlgorithmName": "string",
- "messageDigestInHex": "string",
- "cmssSignatureInHex": "string",
- "signatureLevel": "string",
- "signingTime": 0,
- "certificateInHex": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing process status
Get Smart-ID signing process status using poll or waite till result mechanism
path Parameters
session required | string Example: 9f68c94e-086e-461d-9cda-6a919c9ed603 Session code from signing initiation request response |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}
Get Smart-ID signing process status
Get Smart-ID signing process status using poll or waite till result mechanism
path Parameters
session required | string Example: 9f68c94e-086e-461d-9cda-6a919c9ed603 Session code from signing initiation request response |
pollwaitinmilliseconds required | integer <int64> Example: 90000 Poll wait in milliseconds. Long waite enabled if exists and is positive number. In case of missing parameter, 0 or negative value immediate poll response. |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "serialNumber": "string",
- "commonName": "string"
}, - "documentID": "string",
- "sessionCode": "string",
- "verificationCode": "string",
- "digestAlgorithm": "SHA1",
- "hex": "string",
- "qrData": "string",
- "autoStartToken": "string",
- "containerId": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "isValid": true,
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "organizationId": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
], - "issuer": {
- "organizationId": "string",
- "country": "string",
- "organization": "string",
- "commonName": "string"
}, - "certInBase64": "string",
- "signatureQualification": "string",
- "signatureLevel": "XML-NOT-ETSI"
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "valid": true
}
}
}